about summary refs log tree commit diff
path: root/doc/builders
AgeCommit message (Collapse)AuthorFilesLines
2023-09-18rewrite `runCommand` interface docsValentin Gagarin1-2/+19
specifically this corrects the misleading statement that `env` takes environment variables for the derivation.
2023-09-15Merge pull request #254967 from nbraud/sha256-to-hash/top-levelMaciej Krüger1-1/+1
2023-09-14fetchDebianPatch: Require patch names with extensionsWeijia Wang1-2/+2
Otherwise the fetcher is unuseable with patches whose filename (in Debian) doesn't end in `.patch`.
2023-09-13doc: Replace `sha256` with `hash` where appropriatenicoo1-1/+1
2023-09-12noto-fonts-emoji → noto-fonts-color-emojinicoo1-2/+2
Clarify that the monochrome font is not included, per #221181. The new name is also coherent with the name of the font, according to `fontconfig`: Noto Color Emoji.
2023-08-30doc/fetchers: fetchDebianPatch: don't imply how long a patch remains availablenicoo1-2/+2
2023-08-30fetchDebianPatch: Rename `patch` parameter, make `name` overrideablenicoo1-1/+1
This allows using the fetcher with `invalidateFetcherByDrvHash` for testing.
2023-08-30fetchers: document fetchDebianPatchnicoo1-0/+47
2023-08-25emacs: remove outdated doc about package initializationLin Jian1-4/+0
Since Emacs 27[1], there is no need to call package-initialize in the init file. [1]: https://git.savannah.gnu.org/cgit/emacs.git/tree/etc/NEWS.27?id=cae528457cb862dc886a34240c9d4c73035b6659#n227
2023-08-25emacs: update doc about emacs.pkgs.withPackagesLin Jian1-1/+1
2023-08-14treewide: `overrideScope'` -> `overrideScope`Artturin1-2/+2
`lib.makeScope` `overrideScope'` has been renamed to `overrideScope` `fd --type f | xargs sd --string-mode "overrideScope'" "overrideScope"`
2023-08-08testers.hasPkgConfigModules: allow checking multiple pkg-config modssternenseemann1-5/+19
This is very useful in conjunction with meta.pkgConfigModules, as the new tester can use the list provided by this meta attribute as a default value for moduleNames, making its usage in passthru.tests very convenient. For backwards compatibility, a shim under the old name is maintained with a warning.
2023-07-24treewide: rename fonts.fonts to fonts.packagesSandro Jäckel1-1/+3
2023-07-08Merge pull request #240860 from Atemu/fhsenv-no-multiarchAtemu1-0/+2
buildFHSEnv: disable multiArch by default
2023-07-06darwin.linux-builder: rename from `darwin.builder`Michael Hoang1-3/+7
2023-07-06darwin.builder: use port 31022 by defaultMichael Hoang1-4/+10
2023-07-01doc: render nixpkgs manual with nrdpennae7-58/+52
also updates nixdoc to 2.3.0. the nixdoc update is not a separate commit because that would leave the manual build broken for one commit, potentially breaking bisects and rebases.
2023-07-01buildFHSEnv: add multiArch flagAtemu1-0/+2
The intention is to allow the user control over whether 32bit deps are supposed to be included in the fhsenv
2023-06-10doc: normalize markdown for nixos-render-docspennae1-1/+1
pandoc recognizes `::: note` admonitions, nixos-render-docs only recognizes `::: {.note}`. surprisingly pandoc also emits the correct docbook tags for `[](#xref)`s, so we can use that too.
2023-06-10doc: make sure section depths are consecutivepennae1-1/+1
skipping heading levels (eg from # to ###, or starting at ###) is legal in pandoc, but not in nixos-render-docs. pandoc acts as though section levels *were* consecutive, nixos-render-docs prefers to tell people not to do that kind of thing because it can make documents more fragile.
2023-06-10doc: add missing section IDspennae2-11/+11
2023-06-07Improve `fetchFromGitLab` manual (#236111)Basile Clément1-2/+7
* doc/builders: update fetchers documentation Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-05-22doc:fhs-envs: rewordAtemu1-4/+8
2023-05-22doc:fhs-envs: format example properlyAtemu1-12/+12
That sort of formatting wouldn't be accepted into Nixpkgs. We shouldn't format an example like that.
2023-05-22doc:fhs-envs: mention that runScript must be escaped by the callerAtemu1-1/+2
2023-05-11testers.runNixOSTest: initRobert Hensing1-0/+20
An up to date alternative to pkgs.nixosTest
2023-04-16tree-wide: buildFHSUserEnv -> buildFHSEnvAtemu1-3/+3
2023-04-10Update vmTools docs after rebaseLeandro Emmanuel Reina Kiperman1-25/+57
2023-04-09doc: add vmToolsLeandro Reina2-0/+117
2023-04-07nixos/darwin-builder: add disk space options (#224480)Geraint Ballinger1-0/+86
2023-03-27doc: assign ids to many headingspennae7-15/+15
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-11doc: document fetchpatch's decode argumentAlyssa Ross1-0/+1
2023-03-04Merge pull request #218043 from addict3d/parameterise-guest-memsize-1Ryan Lahfa1-0/+1
nixos/lib/make-disk-image: expose memSize parameter
2023-02-26nixos/lib/make-disk-image: expose memSize parameterNick Bathum1-0/+1
Generating large disk images can fail from out-of-memory in vm-run.
2023-02-10Merge pull request #208537 from Artturin/makesetuphooksupportstrictdepsArtturi2-0/+38
2023-02-07Doc tweak: "Build" -> "Substitute"Tom McLaughlin1-1/+1
2023-02-07Introduce mkBinaryCache functionTom McLaughlin2-0/+50
2023-02-07add docs for makeSetupHookArtturin2-0/+38
2023-02-05Merge pull request #214763 from lheckemann/doc-requirefileLinus Heckemann1-0/+27
fetchers: document requireFile
2023-02-05fetchers: document requireFileLinus Heckemann1-0/+27
2023-01-30testers.hasPkgConfigModule: Extract and add tests, docsRobert Hensing1-0/+13
2023-01-26fix: doc typoMatthew Kenigsberg1-1/+1
2023-01-24doc: fix broken linksNaïm Favier2-3/+3
2023-01-03darwin.builder: auto-login as the `builder` user (#208772)Gabriella Gonzalez1-5/+7
… as suggested by @NiklasGollenstede in: https://github.com/NixOS/nixpkgs/pull/206951#issuecomment-1369020601 This simplifies the user experience for logging into and debugging the machine and also simplifies the instructions for shutting down the machine gracefully.
2023-01-02darwin.builder: prefer shutting down over halting VM (#208450)Winter1-1/+2
This is preferable because it prevents things like disk corruption (requiring the user to delete the disk image when starting up) that I consistently ran into.
2023-01-01Merge pull request #208176 from ncfavier/markdown-no-trailingNaïm Favier2-2/+2
2022-12-29darwin.builder: Remove trailing `'` from host keyGabriella Gonzalez1-1/+1
The trailing `'` was included by mistake and is not supposed to be there: ```ShellSession $ base64 -w0 /etc/ssh/ssh_host_ed25519_key.pub c3NoLWVkMjU1MTkgQUFBQUMzTnphQzFsWkRJMU5URTVBQUFBSUpCV2N4Yi9CbGFxdDFhdU90RStGOFFVV3JVb3RpQzVxQkorVXVFV2RWQ2Igcm9vdEBuaXhvcwo= ``` The reason it did not cause issues before is because Nix ignores everything after the `=`: https://github.com/NixOS/nix/blob/3dbf9b5af5950b615ec685c1f4155b1c8698bb78/src/libutil/util.cc#L1539-L1540 … so it's harmless but still worth fixing.
2022-12-29.editorconfig: apply trailing whitespace removalNaïm Favier2-2/+2
editorconfig-checker -disable-indent-size **/*.md
2022-12-27doc,nixos/doc: unescape apostrophesNaïm Favier2-2/+2
Leftovers from the CommonMark conversion.
2022-12-24nixos/lib/make-disk-image: docs, UEFI vars recording, more determinismRaito Bezarius2-0/+108
- Extensive documentation in NixOS manual - Deterministic mode that fixes various identifiers relative to disk partitions and filesystems in ext4 case - UEFI variable recording