cafkafk/nixpkgs
cafkafk/nixpkgs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2
590994 commits 1 branch 0 tags 3.7 GiB
Commit graph

52 commits

Author SHA1 Message Date
DS
62552e3683 doc: update docs for portableService, follow doc conventions 2024-02-29 17:10:01 +01:00
Silvan Mosberger
67e55070eb
Merge pull request #290886 from DanielSidhion/update-ocitools 
doc: update docs in ociTools, follow doc conventions
 2024-02-29 16:32:36 +01:00
DS
c73de6fac3 doc: update docs in ociTools, follow doc conventions 2024-02-29 16:30:04 +01:00
WxNzEMof
7799f4695b Document the new streamLayeredImage parameters 2024-02-26 18:41:07 +00:00
Matthieu Coudron
0c3eca2682
doc/fetchers: document downloadToTemp for fetchurl (#288762) 
* doc/fetchers: document downloadToTemp for fetchurl

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
 2024-02-22 16:10:21 +01:00
Robert Hensing
d2dfcfcfad
Merge pull request #289584 from athre0z/docker-zstd 
dockerTools: configurable compression schema
 2024-02-19 18:06:54 +01:00
Joel Höner
4b603ad9cd dockerTools: configurable compression schema 
This commit adds support for swapping out the compression algorithm
used in all major docker-tools commands that generate images. The
default algorithm remains unchanged (gzip).
 2024-02-17 18:52:42 +01:00
DS
ba79b098ea doc: use long-form docker commands, improve wording 2024-02-12 15:38:00 -08:00
DS
5677230de3 doc: update buildNixShellImage docs, add streamNixShellImage docs 2024-02-08 07:49:16 -08:00
Silvan Mosberger
b94e9dd7a5
Merge pull request #285223 from DanielSidhion/update-dockertools-envhelpers 
doc: update environment helpers in dockerTools docs, add fakeNss section
 2024-02-08 16:31:33 +01:00
Rebecca Turner
41376dd064
writeShellApplication: Update manual 2024-02-01 16:02:34 -08:00
Daniel Sidhion
2f61aff9ae
doc: update dockerTools.exportImage content and use doc conventions (#283392) 
* doc: update dockerTools.exportImage content and use doc conventions

* Apply suggestions from code review

Co-authored-by: Silvan Mosberger <github@infinisil.com>

---------

Co-authored-by: Silvan Mosberger <github@infinisil.com>
 2024-02-01 16:54:26 +01:00
DS
0445c39047 doc: update environment helpers in dockerTools docs, add fakeNss section 
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
 2024-02-01 01:37:31 -08:00
Silvan Mosberger
2c2b366c59
Merge pull request #283106 from DanielSidhion/update-dockertools-pullimage 
doc: update dockerTools.pullImage content and use doc conventions
 2024-01-25 16:54:18 +01:00
DS
e08482a601 doc: update dockerTools.pullImage content and use doc conventions 2024-01-25 16:51:27 +01:00
Silvan Mosberger
f7609960db
Merge pull request #283394 from DanielSidhion/fix-dockertools-example 
doc: add missing attribute to example in dockerTools
 2024-01-25 16:19:30 +01:00
Kevin Brubeck Unhammer
ad99ac9356
doc: Note on how to use shadowSetup with buildLayeredImage (#267220) 
* Note on how to use shadowSetup with buildLayeredImage

* Update doc/build-helpers/images/dockertools.section.md

---------

Co-authored-by: Silvan Mosberger <github@infinisil.com>
 2024-01-25 16:10:21 +01:00
DS
ad83240aad doc: add missing attribute to example in dockerTools 2024-01-23 20:58:41 -08:00
DS
2004205b7a doc: update content on dockerTools layered images and follow doc conventions 2024-01-18 17:26:24 +01:00
Silvan Mosberger
af358ee11c
Merge pull request #278956 from DanielSidhion/update-dockertools-buildimage 
doc: update content on dockerTools.buildImage and follow doc conventions
 2024-01-18 16:18:44 +01:00
Silvan Mosberger
dc30cf4f88
Merge pull request #259567 from Eisfunke/document-mkShellNoCC 
doc: add section about mkShellNoCC
 2024-01-18 16:10:21 +01:00
DS
2c9e2b6569 doc: update content on dockerTools.buildImage and follow doc conventions 2024-01-16 23:56:59 -08:00
Valentin Gagarin
b22ec91243 review pass 2024-01-15 22:34:00 +01:00
Chris McDonough
2e2aaa1c2e do not nest a note within a warning, break out writeTextFile examples into multiple example sections, test first writeTextFile example (it was broken, heh) and fix, move prose out of code blocks 2024-01-15 11:29:35 -05:00
Chris McDonough
39a1686e56
Add a period 
Co-authored-by: Alexander Groleau <alex@proof.construction>
 2024-01-15 10:49:51 -05:00
Chris McDonough
cec3e9441c
Move prose 
Co-authored-by: Alexander Groleau <alex@proof.construction>
 2024-01-15 10:49:36 -05:00
Robert Hensing
559d06bbb2 trivial-builders: Remove redundant docs - link instead 2024-01-15 09:02:45 +01:00
Nicolas Lenz
8c65bdc334
doc: add section about mkShellNoCC 2024-01-14 10:54:17 +01:00
Chris McDonough
b0f542304d add to example 2024-01-12 22:59:49 -05:00
Chris McDonough
39227d5ce3 describing the composiion of the store path elements is not really that useful 2024-01-12 22:53:50 -05:00
Chris McDonough
56108dd5ab not realized; produced 2024-01-12 22:49:04 -05:00
Chris McDonough
7aa84efba2 incorporate the suggestion at https://github.com/NixOS/nixpkgs/pull/277534/files#r1450959283 2024-01-12 22:17:39 -05:00
Chris McDonough
25b2c3a0cc incorporate the spirit of change proposed by @DanielSidhion at https://github.com/NixOS/nixpkgs/pull/277534#discussion_r1450778530 2024-01-12 22:15:43 -05:00
Chris McDonough
32638686d1
Apply @bzm3r suggestions from code review 
Co-authored-by: Brian Merchant <bzm3r@proton.me>
 2024-01-12 21:58:13 -05:00
Chris McDonough
1e9fc75c6e whitespace cleanup 2024-01-12 12:17:24 -05:00
Chris McDonough
41c3d2d96c update arguments to definition lists as per docs team meeeting / @danielsidhion 2024-01-12 11:24:26 -05:00
Chris McDonough
e9ff890c46 Merge remote-tracking branch 'upstream/master' into doc-trivial-builders-writetext 2024-01-12 11:03:48 -05:00
Bryan Lai
d7253bea6d doc: polish the docs of checkpointBuildTools 
... following suggestions from @phip1611 and @infinisil.
 2024-01-09 01:34:21 +08:00
Bryan Lai
df62c3c87f checkpointBuildTools: mkCheckpointedBuild -> mkCheckpointBuild 
All other functions are in the form of `*{c,C}heckpointBuild*`, so we
deprecate the `mkCheckpointedBuild` function in favor of `mkCheckpointBuild`.

Also address some inconsistencies in the docs: some `buildOutput` should
actually be `incrementalBuildArtifacts`.
 2024-01-08 19:42:16 +08:00
Chris McDonough
f4cdad8aab doc: improve documentation for trivial text writing functions 2023-12-29 13:12:56 -05:00
DS
f0fb6f0a26 doc: update mkBinaryCache section with admonitions and conventions 
The mkBinaryCache section now follows the convention of using one
line per sentence, as well as using admonitions for notes and
examples.

The example syntax was updated to define a fully-working nix package.
 2023-12-25 17:34:59 -08:00
Daniel Sidhion
e525be5a07
doc: update the appimageTools section content and examples (#276029) 
The following changes are made:
- Document how `wrapType2` and `wrapType1` are the same thing.
- Expand on how `wrapType2` works and additional arguments it uses.
- Document `extract` and show how it's used in combination with
  `wrapType2`.
- Provide full working examples using the new admonition syntax.
 2023-12-23 11:36:25 +01:00
Daniel Sidhion
292ea0d917
doc: migrate examples in testers chapter to admonitions (#275791) 2023-12-21 12:54:32 +01:00
DS
b47d073e2d doc: add more details on testers.testVersion 2023-12-20 03:04:32 -08:00
messemar
5ebb78d952
doc: checkpointBuild: fix wording 
Co-authored-by: Philipp Schuster <phip1611@gmail.com>
 2023-12-13 11:15:29 +01:00
Martin Messer
15c2c6827b checkpointBuild: doc remove textual description in favor of an integrated example 2023-12-12 14:12:15 +01:00
messemar
0d6d654f36
doc: checkpointBuild: fix wording 
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
 2023-12-12 13:19:21 +01:00
messemar
f61980dbf9
doc: fix typo in checkpoint build section 
Co-authored-by: Markus Partheymueller <markus.partheymueller@cyberus-technology.de>
 2023-12-12 10:43:54 +01:00
Martin Messer
0ab2262bdd checkpointBuild: fix whitespaces in documentation 2023-12-07 17:15:17 +01:00
Martin Messer
6db9612204 rename: incremental -> checkpointed builds 2023-12-07 16:56:16 +01:00