aboutsummaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2022-12-13doc: fix linksNaïm Favier
2022-12-12Merge remote-tracking branch 'upstream/master' into indexed-store-path-outputsJohn Ericson
2022-12-12Merge remote-tracking branch 'upstream/master' into indexed-store-path-outputsJohn Ericson
2022-12-12Improve release notesJohn Ericson
2022-12-12suggestions from reviewValentin Gagarin
2022-12-12Add links to the manualEelco Dolstra
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-12-12Support flake references in the old CLIEelco Dolstra
Fixes #7026.
2022-12-12Merge pull request #7421 from edolstra/lazy-trees-trivial-changesEelco Dolstra
Trivial changes from the lazy-trees branch
2022-12-12Merge branch 'master' into indexed-store-path-outputsJohn Ericson
2022-12-12Tweak NIX_PATH descriptionEelco Dolstra
2022-12-12Fix indentationEelco Dolstra
2022-12-12Manual improvementsEelco Dolstra
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-12-09Merge pull request #7324 from CircuitCoder/masterThéophane Hufschmitt
Update uninstall guide involving systemd
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-07Trivial changes from the lazy-trees branchEelco 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-05disallow selecting shell prompt in code samplesValentin Gagarin
this is a quick half-fix for command line examples, as discussed discussed in [1]. [1]: https://github.com/NixOS/nix/pull/7389 examples which look like this $ foo bar baz are confusing for Unix shell beginners, because it's hard to discern what is supposed to be entered into the actual command line when the convention of prefixing `$` is not known, as barely any real-world shell looks that way any more. this change prevents selecting the prompt part with the mouse in the HTML representation of the Nix manual. it does not prevent selecting the output part of the shell example. it also does not address that the copy button provided by mdBook takes the entire sample, including the prompts, into the clipboard.
2022-12-01Merge pull request #7251 from RelationalAI-oss/sp-docs-uninstall-promptValentin Gagarin
docs: drop shell prompt character for consistency
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-26Clarify uninstallation steps on LinuxLiu Xiaoyi
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-11-25Merge branch 'master' into indexed-store-path-outputsJohn Ericson
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-21Apply suggestions from code reviewLiu Xiaoyi
Co-authored-by: Sandro <sandro.jaeckel@gmail.com>
2022-11-20Updated uninstall guide involving systemdLiu Xiaoyi
Co-authored-by: sequencer <liu@jiuyang.me>
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-09remove external linkValentin Gagarin
the language has its own overview page where its properties are described in sufficient detail.
2022-11-09make diagrams compatible with svgbobValentin Gagarin
this will at some point enable rendering them nicely for the web
2022-11-09clarify subject of sentenceValentin Gagarin
Co-authored-by: Bryan Honof <bryan.honof@tweag.io>
2022-11-09add articlesValentin Gagarin
2022-11-09manual: architecture overviewValentin Gagarin
these changes were not merged properly and had to be reverted. see merge commit d8e54d19f71f78540dd967b2e42be6a5d8a0b1bb for full history leading up to here.
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).