Commit graph

229 commits

Author SHA1 Message Date
Valentin Gagarin
35d066de5f rewrite runCommand interface docs
specifically this corrects the misleading statement that `env` takes
environment variables for the derivation.
2023-09-18 17:47:47 +02:00
Maciej Krüger
7b737acb4a
Merge pull request #254967 from nbraud/sha256-to-hash/top-level 2023-09-15 14:36:49 +02:00
Weijia Wang
0cfc319f83 fetchDebianPatch: Require patch names with extensions
Otherwise the fetcher is unuseable with patches
whose filename (in Debian) doesn't end in `.patch`.
2023-09-14 18:55:30 +00:00
nicoo
fe138d36c9 doc: Replace sha256 with hash where appropriate 2023-09-13 17:24:49 +00:00
nicoo
c7423cd734 noto-fonts-emoji → noto-fonts-color-emoji
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-09-12 12:38:07 +00:00
nicoo
d613fb52c9 doc/fetchers: fetchDebianPatch: don't imply how long a patch remains available 2023-08-30 08:06:10 +00:00
nicoo
d4e265327f fetchDebianPatch: Rename patch parameter, make name overrideable
This allows using the fetcher with `invalidateFetcherByDrvHash` for testing.
2023-08-30 07:53:05 +00:00
nicoo
7122aea569 fetchers: document fetchDebianPatch 2023-08-30 07:53:05 +00:00
Lin Jian
665651c736 emacs: remove outdated doc about package initialization
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-25 10:22:30 +00:00
Lin Jian
71a8753134 emacs: update doc about emacs.pkgs.withPackages 2023-08-25 10:22:30 +00:00
Artturin
b93da3f4b7 treewide: overrideScope' -> overrideScope
`lib.makeScope` `overrideScope'` has been renamed to `overrideScope`

`fd --type f | xargs sd --string-mode "overrideScope'" "overrideScope"`
2023-08-14 18:46:47 +03:00
sternenseemann
af60e68744 testers.hasPkgConfigModules: allow checking multiple pkg-config mods
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-08-08 19:16:48 +02:00
Sandro Jäckel
b0c67b4b6e
treewide: rename fonts.fonts to fonts.packages 2023-07-24 17:34:39 +02:00
Atemu
67eec418ab
Merge pull request #240860 from Atemu/fhsenv-no-multiarch
buildFHSEnv: disable multiArch by default
2023-07-08 13:53:41 +02:00
Michael Hoang
edef486898 darwin.linux-builder: rename from darwin.builder 2023-07-06 21:33:09 +10:00
Michael Hoang
285f5e858e darwin.builder: use port 31022 by default 2023-07-06 21:32:08 +10:00
pennae
be4d19ff1a doc: render nixpkgs manual with nrd
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-01 20:59:29 +02:00
Atemu
62b2adc753 buildFHSEnv: add multiArch flag
The intention is to allow the user control over whether 32bit deps are supposed
to be included in the fhsenv
2023-07-01 13:41:14 +02:00
pennae
2ecc93d6fe doc: normalize markdown for nixos-render-docs
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-10 18:17:05 +02:00
pennae
e42a5c78e7 doc: make sure section depths are consecutive
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-10 18:17:04 +02:00
pennae
830f5b33dd doc: add missing section IDs 2023-06-10 18:17:04 +02:00
Basile Clément
66f57b6c18
Improve fetchFromGitLab manual (#236111)
* doc/builders: update fetchers documentation

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-06-07 10:51:48 +02:00
Atemu
3009b12817 doc:fhs-envs: reword 2023-05-22 11:34:04 -03:00
Atemu
e57efc6cb7 doc:fhs-envs: format example properly
That sort of formatting wouldn't be accepted into Nixpkgs. We shouldn't format
an example like that.
2023-05-22 11:34:04 -03:00
Atemu
8912c50fc7 doc:fhs-envs: mention that runScript must be escaped by the caller 2023-05-22 11:34:04 -03:00
Robert Hensing
ac1134f321 testers.runNixOSTest: init
An up to date alternative to pkgs.nixosTest
2023-05-11 19:12:07 +02:00
Atemu
f63a12f296 tree-wide: buildFHSUserEnv -> buildFHSEnv 2023-04-16 10:15:13 +02:00
Leandro Emmanuel Reina Kiperman
a6c19474bd Update vmTools docs after rebase 2023-04-10 00:43:31 +02:00
Leandro Reina
0eff947d0b doc: add vmTools 2023-04-09 21:55:50 +02:00
Geraint Ballinger
8b2521bdae
nixos/darwin-builder: add disk space options (#224480) 2023-04-07 05:10:49 +02:00
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
Alyssa Ross
e636a55c15 doc: document fetchpatch's decode argument 2023-03-11 21:39:29 +00:00
Ryan Lahfa
0397ee1113
Merge pull request #218043 from addict3d/parameterise-guest-memsize-1
nixos/lib/make-disk-image: expose memSize parameter
2023-03-04 11:25:23 +01: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
Artturi
aaa9ea8ec6
Merge pull request #208537 from Artturin/makesetuphooksupportstrictdeps 2023-02-10 20:08:32 +02: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
Artturin
680309fc9c add docs for makeSetupHook 2023-02-07 21:02:02 +02:00
Linus Heckemann
59b752087d
Merge pull request #214763 from lheckemann/doc-requirefile
fetchers: document requireFile
2023-02-05 18:28:01 +01:00
Linus Heckemann
2e88127a0d fetchers: document requireFile 2023-02-05 15:33:51 +01:00
Robert Hensing
b6bec17eb9 testers.hasPkgConfigModule: Extract and add tests, docs 2023-01-30 00:35:34 +01:00
Matthew Kenigsberg
2334404fb0 fix: doc typo 2023-01-26 16:45:59 -07:00
Naïm Favier
4580a6608d
doc: fix broken links 2023-01-24 13:27:27 +01:00
Gabriella Gonzalez
6d89aa8f1d
darwin.builder: auto-login as the builder user (#208772)
… 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-03 21:12:56 -08:00
Winter
15013b3054
darwin.builder: prefer shutting down over halting VM (#208450)
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-02 07:36:41 -08:00
Naïm Favier
8796411139
Merge pull request #208176 from ncfavier/markdown-no-trailing 2023-01-01 14:15:05 +01:00
Gabriella Gonzalez
930b0dfbc1 darwin.builder: Remove trailing ' from host key
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 `=`:

3dbf9b5af5/src/libutil/util.cc (L1539-L1540)

… so it's harmless but still worth fixing.
2022-12-29 07:19:16 -06: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