aboutsummaryrefslogtreecommitdiff
path: root/doc/manual
AgeCommit message (Collapse)Author
2023-01-06Merge pull request #7498 from fricklerhandwerk/path+stringEelco Dolstra
refactor documentation of operators, document `+` for strings and paths
2023-01-05Merge pull request #7500 from akhildevelops/patch-1Eelco Dolstra
Updated docs to delete build users and group
2023-01-05bring back table, extract annotationsValentin Gagarin
this makes the table less unwieldy, and leaves enough space for extensive explanations.
2023-01-05add links to documentation for data typesValentin Gagarin
2023-01-05use more self-explanatory placeholder namesValentin Gagarin
2023-01-05add semantics of overloaded `+` operatorValentin Gagarin
2023-01-05reword descriptions of operatorsValentin Gagarin
add notes on semantics where appropriate
2023-01-05convert table to subsectionsValentin Gagarin
this form is much easier to maintain (also with minimal diffs), and allows for more details on each operator. this change a purely mechanical transformation, without changing any contents.
2023-01-05reorder columnsValentin Gagarin
this is for a simpler transformation into a series of subsections
2023-01-02Merge remote-tracking branch 'origin/master' into coerce-stringEelco Dolstra
2023-01-02Merge pull request #7278 from fricklerhandwerk/antiquotationThéophane Hufschmitt
antiquotation -> string interpolation
2023-01-02Merge pull request #7066 from fricklerhandwerk/architecture-overviewThéophane Hufschmitt
manual: architecture overview
2023-01-02antiquotation -> string interpolationValentin Gagarin
as proposed by @mkaito[1] and @tazjin[2] and discussed with @edolstra and Nix maintainers [1]: https://github.com/NixOS/nix.dev/pull/267#issuecomment-1270076332 [2]: https://github.com/NixOS/nix.dev/pull/267#issuecomment-1270201979 Co-authored-by: John Ericson <git@JohnEricson.me> Co-authored-by: Eelco Dolstra <edolstra@gmail.com>
2023-01-02Merge pull request #7470 from obsidiansystems/simplify-tests-slightlyEelco Dolstra
Make `./mk/run-test.sh` work by itself; add `mk/debug-test.sh`
2023-01-02Merge pull request #7485 from fricklerhandwerk/doc-store-derivationThéophane Hufschmitt
define "store derivation"
2022-12-23Apply suggestions from code reviewJohn Ericson
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-12-23nix develop: Set personalityEelco Dolstra
This makes 'nix develop' set the Linux personality in the same way that the actual build does, allowing a command like 'nix develop nix#devShells.i686-linux.default' on x86_64-linux to work correctly.
2022-12-23Deletes build users and groupAkhil
2022-12-21link "store derivation" to glossary definitionValentin Gagarin
2022-12-21update description of "store derivation" in installables sectionValentin Gagarin
a store derivation is not a store path itself, it has a store path.
2022-12-21define "store derivation"Valentin Gagarin
2022-12-21Make `./mk/run-test.sh` work by itself; add `mk/debug-test.sh`John Ericson
First, logic is consolidated in the shell script instead of being spread between them and makefiles. That makes understanding what is going on a little easier. This would not be super interesting by itself, but it gives us a way to debug tests more easily. *That* in turn I hope is much more compelling. See the updated manual for details. Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io> Co-authored-by: Eelco Dolstra <edolstra@gmail.com> Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2022-12-20doc/book.toml: Improve config (#7300)Robert Hensing
* doc/book.toml: Improve config - `title` value will be added to the HTML <title> - here</title> - `git-repository-url` adds a link to the GitHub repo in the top right corner - `edit-url-template` adds an edit link, inviting contributions Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-12-20make relative links explicitValentin Gagarin
2022-12-20add more explanation to diagramsValentin Gagarin
this is to help reading the diagrams, otherwise arrows and labels were reported as being ambiguous.
2022-12-13Merge pull request #7456 from ncfavier/fix-linksEelco Dolstra
doc: fix links
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-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