Commit Graph

25 Commits

Author SHA1 Message Date
Travis A. Everett
9ff9bbdb34
doc: add stdenv passthru chapter (#315909)
* doc: add stdenv passthru chapter

Broad strokes:
- create the chapter
- move existing stdenv passthru coverage into it
- move out-of-place coverage of passthru.tests from the stdenv meta chapter into it
- (try to) apply 1-sentence-per-line to text I've touched
- add legacy anchors for everything moved
- update existing links to the new anchors
- add tentative motivating text
- make nixpkgs-internal links relative/branchless

razor: if it is only ever needed by contributors, which is likely if links
refer to the latest revision of the source code, then it's for
the contributor guide

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2024-06-11 10:51:03 +02:00
Alyssa Ross
ba96c1f7e5 doc: fix make-disk-image.nix example 2024-06-04 21:46:41 +01:00
Janne Heß
fcc95ff817 treewide: Fix all Nix ASTs in all markdown files
This allows for correct highlighting and maybe future automatic
formatting. The AST was verified to work with nixfmt only.
2024-03-28 09:28:12 +01:00
DS
1d85557b50 snapTools: remove
`snapTools.makeSnap` has produced broken snaps since at least Oct 2020,
as indicated by the following issue: https://github.com/NixOS/nixpkgs/issues/100618

No person has shown interest in maintaining it, and given that there is
no fix available, it's assumed that all attempts made to fix that
function have not succeeded.

Given that `snapTools` only contained `makeSnap`, it was removed
completely.
2024-03-04 22:22:14 -08:00
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
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
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
DS
2c9e2b6569 doc: update content on dockerTools.buildImage and follow doc conventions 2024-01-16 23:56:59 -08: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
Yueh-Shun Li
9963ad5c5f doc: builders -> build helpers to reduce ambigualty 2023-11-07 19:58:53 +00:00