Commit graph

47 commits

Author SHA1 Message Date
pennae 052bb41410 doc: assign ids to many headings
without stable ids on headings we cannot generate stable links to these
headings. nrd complains about this, but the current docbook workflow
does not.

a few generated ids remain, mostly in examples and footnotes. most of
the examples are generated by nixdoc (which has since gained MD export
functions, and the MD export does generate IDs).
2023-03-27 22:39:11 +02:00
Nick Bathum 59462da917
nixos/lib/make-disk-image: expose memSize parameter
Generating large disk images can fail from out-of-memory in vm-run.
2023-02-26 12:08:58 -05:00
Tom McLaughlin 700e6e588e Doc tweak: "Build" -> "Substitute" 2023-02-07 16:17:52 -08:00
Tom McLaughlin d1a2a16a3a Introduce mkBinaryCache function 2023-02-07 16:16:07 -08:00
Matthew Kenigsberg 2334404fb0 fix: doc typo 2023-01-26 16:45:59 -07:00
Naïm Favier 22ea90a4d8
.editorconfig: apply trailing whitespace removal
editorconfig-checker -disable-indent-size **/*.md
2022-12-29 01:40:50 +01:00
Naïm Favier d11832fd96
doc,nixos/doc: unescape apostrophes
Leftovers from the CommonMark conversion.
2022-12-27 17:13:47 +01:00
Raito Bezarius 22adcaa449 nixos/lib/make-disk-image: docs, UEFI vars recording, more determinism
- Extensive documentation in NixOS manual
- Deterministic mode that fixes various identifiers relative to disk
  partitions and filesystems in ext4 case
- UEFI variable recording
2022-12-24 19:15:29 +01:00
Christian Kemper f6ae4479ea dockerTools: allowing architecture to be specified
... for buildImage, buildLayeredImage and streamLayeredImage,
adding docs and tests.
2022-12-08 20:29:09 +01:00
Colin Arnott bac379f30a
doc: use sri hash syntax
The nixpkgs manual contains references to both sri hash and explicit
sha256 attributes. This is at best confusing to new users. Since the
final destination is exclusive use of sri hashes, see nixos/rfcs#131,
might as well push new users in that direction gently.

Notable exceptions to sri hash support are builtins.fetchTarball,
cataclysm-dda, coq, dockerTools.pullimage, elixir.override, and
fetchCrate. None, other than builtins.fetchTarball, are fundamentally
incompatible, but all currently accept explicit sha256 attributes as
input. Because adding backwards compatibility is out of scope for this
change, they have been left intact, but migration to sri format has been
made for any using old hash formats.

All hashes have been manually tested to be accurate, and updates were
only made for missing upstream artefacts or bugs.
2022-12-04 06:12:18 +00:00
Silvan Mosberger a566d0842e
Merge pull request #172736 from infinisil/docker-nix-shell 2022-11-26 20:21:59 +01:00
Ryan Mulligan f3d0e1d5c3 nixpkgs/doc: fix admonition syntax
Match admonition syntax in

https://nixos.org/manual/nixpkgs/unstable/#chap-contributing
2022-11-08 07:30:20 -08:00
Silvan Mosberger 8ec0837a72 Introduce dockerTools.buildNixShellImage 2022-10-07 22:04:22 +02:00
Дамјан Георгиевски 4e385bec15
add documentation for the pkgs.portableService tool (#193081)
* add documentation for the pkgs.portableService tool

as introduced in 499aebcf34

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-10-07 10:37:56 +02:00
Robert Hensing 62b25a28fe
Merge pull request #170906 from Sohalt/dockerTools.ca-certificates.crt
dockerTools ca-certificates.crt helper
2022-08-31 14:08:02 +02:00
Alex James c9af898255
dockerTools.buildImage: make VM memSize configurable
Fixes #186752. This adds buildVMMemorySize (defaults to 512 MiB) to
buildImage, which is passed to vm.runInLinuxVM. This is needed for
larger base images, which may otherwise cause container build failures
due to OOM in the VM.
2022-08-16 21:47:29 -05:00
Florian Klink 6e254a6c35 nixos/doc: update contents to copyToRoot
contents is deprecated now, use the copyToRoot attribute.
2022-08-01 13:41:41 +07:00
Florian Klink 4393ed8679 Update doc/builders/images/dockertools.section.md
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2022-08-01 13:34:20 +07:00
Florian Klink d84e7842a5 nixos/doc: document fakeNss, binSh 2022-08-01 13:34:20 +07:00
sohalt c9d8e34fc4 dockerTools: document environment helpers 2022-07-07 14:50:23 +02:00
Robert Hensing e007eb480c dockerTools.buildImage: Add copyToRoot to replace contents, explain usage 2022-07-06 07:30:24 +02:00
Mirco Bauer ac66ff97ed doc/builders/images/dockertools: improve shadowSetup example
The example snippet will fail with this error as it is not self contained and
assumes `shadowSetup` was given:

    $ nix-build docker-image.nix
    error: undefined variable 'shadowSetup' at docker-image.nix:20:7

Instead use the full reference to `shadowSetup` in the example so it will work
as stated.
2022-06-05 09:45:58 +08:00
Martino Fontana 93d624a49a doc/builders: fix typos 2022-03-10 20:43:29 +01:00
Robert Hensing ddda5f28e1 dockerTools: Keep fakechroot disabled by default
Avoid risk of breaking existing images by making it opt-in.
2021-12-04 13:49:10 +00:00
Robert Hensing 0e9bc9ffd1 dockerTools: Add fakechroot to fakeRootCommands 2021-12-04 13:49:10 +00:00
Jan Tojnar 6ecc641d08
doc: prepare for commonmark
We are still using Pandoc’s Markdown parser, which differs from CommonMark spec slightly.

Notably:
- Line breaks in lists behave differently.
- Admonitions do not support the simpler syntax https://github.com/jgm/commonmark-hs/issues/75
- The auto_identifiers uses a different algorithm – I made the previous ones explicit.
- Languages (classes) of code blocks cannot contain whitespace so we have to use “pycon” alias instead of Python “console” as GitHub’s linguist

While at it, I also fixed the following issues:
- ShellSesssion was used
- Removed some pointless docbook tags.
2021-06-07 06:34:59 +02:00
Bobby Rong 228276fbd0 doc/builders/images/*.xml: Convert to markdown 2021-04-24 09:06:33 +08:00
Robert Hensing 58b21dea78
Merge pull request #116749 from vroad/docker-layered-image-fakeroot
dockerTools.streamLayeredImage: add fakeRootCommands option
2021-04-07 15:02:24 +02:00
Ryan Mulligan d9b57bfc2c
Merge pull request #108917 from bryanasdev000/doc-ocitools
ocitools: Update doc to use CommonMark
2021-03-31 21:51:38 -07:00
vroad c420e650c9
dockerTools.streamLayeredImage: Update documentation
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2021-03-24 08:24:21 +09:00
Benjamin Hipple 561cc81ee6
Merge pull request #115857 from lbpdt/feature/docker-tools-layered-base-image
dockerTools.buildLayeredImage: support fromImage
2021-03-23 18:15:34 -04:00
Louis Blin aae8588182 dockerTools.buildLayeredImage: support fromImage
It is now possible to pass a `fromImage` to `buildLayeredImage` and
`streamLayeredImage`, similar to what `buildImage` currently supports.

This will prepend the layers of the given base image to the resulting
image, while ensuring that at most `maxLayers` are used. It will also
ensure that environment variables from the base image are propagated
to the final image.
2021-03-23 14:50:42 +00:00
Bryan A. S fdc7280a87 doc/builders/images/ocitools.xml: Convert to markdown
Signed-off-by: Bryan A. S <bryanasdev000@gmail.com>
2021-03-22 20:13:51 -03:00
vroad 2dce2253bc dockerTools.streamLayeredImage: document fakeRootCommands 2021-03-19 11:54:13 +09:00
Florian Engel 3329093c6a Remove repeating words from doc 2021-03-14 12:15:34 +01:00
Benjamin Hipple 9c4353833f doc: remove unnecessary \ escapes in dockertools.section.md
These pollute the plain text and, after re-running `nix-build` and looking at
the result, do not appear to have any impact on the rendered version.
2021-03-09 19:02:56 -05:00
Robert Hensing a1cf35fbfd doc/builders/images/dockertools.section.md: Fix link labels 2021-03-04 17:44:33 +01:00
Bryan A. S 5a1a08c0a7 doc/builders/images/dockertools.section.md: Fix anchor errors
Also change note notation

Signed-off-by: Bryan A. S <bryanasdev000@gmail.com>
2021-03-04 17:18:18 +01:00
Bryan A. S 06e40b3caf doc/builders/images/dockertools.section.md: Indent nix code
Signed-off-by: Bryan A. S <bryanasdev000@gmail.com>
2021-03-04 17:18:17 +01:00
Bryan A. S 4b99dbbbcc doc/builders/images/dockertools.xml: Convert to markdown and start improvements
Need to verify things like `error: IDREF "" without matching ID` and `::: {.note}`

Signed-off-by: Bryan A. S <bryanasdev000@gmail.com>
2021-03-04 17:18:17 +01:00
Jan Tojnar e1af37634b
doc: Improve code listings
By adding prompts and removing unnecessary indentation.
2020-09-23 01:25:25 +02:00
Steve Purcell c9e6a02c82
Add docs for dockerTools.streamLayeredImage 2020-06-22 15:19:44 +12:00
Pavol Rusnak fadcfc3ea4
treewide: per RFC45, remove more unquoted URLs 2020-04-18 14:04:37 +02:00
edef 2aa4fba8d1 doc/ociTools: exec is a shell builtin, not an external command 2020-02-16 17:41:06 +00:00
adisbladis 65ff43e866
doc: Fix callout reference in appimagetools 2020-01-23 17:49:13 +00:00
Graham Christensen 310a028a0c
dockerTools: the API has basically never changed 2019-12-16 13:18:28 -05:00
Frederik Rietdijk 9d54ea9b2d doc: move image builders into new images chapter 2019-10-21 10:57:56 +02:00