aboutsummaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2022-12-08Merge pull request #7379 from fricklerhandwerk/refactor-generate-optionsThéophane Hufschmitt
refactor rendering documentation of options
2022-12-07do not render links in man pagesValentin Gagarin
this is a follow-up on e7dcacb. most links are relative and this should not be too much of a detriment.
2022-12-07use HTML anchors for config parametersValentin Gagarin
this avoids incorrect rendering on the man pages, since `lowdown` neither parses the anchor syntax nor HTML. this should rather be fixed in lowdown, as adding more anchors would otherwise produce ever more noise and error-prone repetition.
2022-12-07Merge branch 'master' into remove-repeatEelco Dolstra
2022-12-07Post build hook signing (#7408)endgame
* docs: Use secret-key-files when demonstrating post-build-hooks The docs used to recommend calling `nix store sign` in a post-build hook, but on more recent versions of nix, this results in unsigned store paths being copied into binary caches. See https://github.com/NixOS/nix/issues/6960 for details. Instead, use the `secret-key-files` config option, which signs all locally-built derivations with the private key. Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-12-07Remove repeat and enforce-determinism optionsLinus Heckemann
These only functioned if a very narrow combination of conditions held: - The result path does not yet exist (--check did not result in repeated builds), AND - The result path is not available from any configured substituters, AND - No remote builders that can build the path are available. If any of these do not hold, a derivation would be built 0 or 1 times regardless of the repeat option. Thus, remove it to avoid confusion.
2022-12-06Release notesEelco Dolstra
2022-12-01refactor rendering documentation of optionsValentin Gagarin
this makes more obvious what the code produces, and the structure of the output easier to change
2022-12-01move documentation on `auto-allocate-uids` to options docsValentin Gagarin
this is where it belongs and can be found together with the other options.
2022-11-30add missing newline, for consistent formattingValentin Gagarin
2022-11-29Merge pull request #7342 from fricklerhandwerk/refactor-generate-builtinsThéophane Hufschmitt
refactor rendering documentation of builtins
2022-11-28Add exampleEelco Dolstra
2022-11-28Add a setting for enabling cgroupsEelco Dolstra
2022-11-24refactor rendering documentation of builtinsValentin Gagarin
as in [1], make the document structure visible, like in a template [1]: 4655563470b59e0ef50a33af003058c2b54db778
2022-11-23Include UID in hexEelco Dolstra
2022-11-23Add release notesEelco Dolstra
2022-11-22fix error in language overviewValentin Gagarin
it is not possible to antiquote numbers.
2022-11-14Add release-notes for the context-restriction in readFileThéophane Hufschmitt
2022-11-11Merge pull request #7279 from fricklerhandwerk/uninstallThéophane Hufschmitt
add removing users to uninstall instructions
2022-11-11remove stray commaValentin Gagarin
2022-11-09Merge pull request #7006 from fricklerhandwerk/redirectsThéophane Hufschmitt
manual: generalize anchor redirects
2022-11-09add removing users to uninstall instructionsValentin Gagarin
2022-11-09Merge pull request #6906 from fricklerhandwerk/language-overviewValentin Gagarin
add syntax overview from NixOS manual
2022-11-09fix typos in commentsValentin Gagarin
2022-11-06manual: build action -> build taskValentin Gagarin
after discussing this with multiple people, I'm convinced that "build task" is more precise: a derivation is not an action, but inert until it is built. also it's easier to pronounce. proposal: use "build task" for the generic concept "description of how to derive new files from the contents of existing files". then it will be easier to distinguish what we mean by "derivation" (a specific data structure and Nix language value type) and "store derivation" (a serialisation of a derivation into a file in the Nix store).
2022-10-26Merge pull request #7191 from jherland/antiquoted-pathsThéophane Hufschmitt
Explain how Nix handles antiquotation of paths
2022-10-20manual: update options generation code to use default valuesPatrick Jackson
2022-10-19Explain how Nix handles antiquotation of pathsJohan Herland
Specifically, explain why Nix does not _re_evaluate paths during a `nix repl` session. This is a thing that bit me while playing around with paths and antiquotation in `nix repl` while reading the Nix language tutorial at https://nix.dev/tutorials/nix-language. Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-10-07Print common flags in --helpAna Hobden
2022-10-05Merge pull request #6652 from abathur/doc_install_testsValentin Gagarin
2022-10-05Apply suggestions from code reviewTravis A. Everett
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-10-05Merge pull request #6870 from ↵Valentin Gagarin
amjoseph-nixpkgs/pr/doc/explain-local-remote-binary-substituter
2022-10-03Merge pull request #6969 from fricklerhandwerk/refactor-generate-manpageThéophane Hufschmitt
refactor rendering command documentation to markdown
2022-09-30bring back lost newlineValentin Gagarin
2022-09-30use more self-explanatory namesValentin Gagarin
2022-09-30move final template to the topValentin Gagarin
this allows readers to enter the code starting with what is visible from the outside, instead of working themselves up from purely technical details.
2022-09-30remove superfluous let-in pairValentin Gagarin
2022-09-30refactor showOptionsValentin Gagarin
it was quite a pain to manipulate strings just with `builtins`
2022-09-30refactor rendering command documentation to markdownValentin Gagarin
idea: - make document structure visible, like in a template - order functions by descending abstraction - avoid nested let bindings
2022-09-30use indented strings where appropriateValentin Gagarin
2022-09-28nix-copy-closure: improve wordingSolene Rapenne
2022-09-24Merge pull request #7082 from rapenne-s/ccacheThéophane Hufschmitt
add ccacheStdenv
2022-09-23add ccacheStdenvSolène Rapenne
when using ccache, rebuild time has been measured 89% faster while not slowing the speed of cold builds
2022-09-18address review feedbackTravis A. Everett
Mainly: - Try to triangulate between narrative that framed this as a new/easy process and the need for a reference that will not quickly grow stale. - Fix a ~continuity issue where the text was talking about "your Cachix cache" before saying that you'd need to make a Cachix cache to enable the installer tests. - Adopt suggestion on titling, and nest subtitles in the installer test section.
2022-09-17Apply suggestions from code reviewTravis A. Everett
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-09-16release-notes/rl-next.md: note new argument to fetchurl.nixAdam Joseph
2022-09-16Update doc/manual/src/contributing/hacking.mdValentin Gagarin
2022-09-16Update doc/manual/src/contributing/hacking.mdValentin Gagarin
2022-09-16Update doc/manual/src/contributing/hacking.mdValentin Gagarin
2022-09-16Update doc/manual/src/contributing/hacking.mdValentin Gagarin