aboutsummaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2023-01-18Revert "Merge pull request #6204 from layus/coerce-string"Robert Hensing
This reverts commit a75b7ba30f1e4f8b15e810fd18e63ee9552e0815, reversing changes made to 9af16c5f742300e831a2cc400e43df1e22f87f31.
2023-01-17TypoEelco Dolstra
2023-01-17Release notesEelco Dolstra
2023-01-16Expand installation.mdAna Hobden
Changes the `quick-start.md` to recommend a multi-user install, since single-user is not supported on MacOS and https://nixos.org/download.html recommends multi-user. Expands `installation.md` to reflect wording on https://nixos.org/download.html
2023-01-10Merge pull request #7541 from hercules-ci/check-manual-linksRobert Hensing
Check links in the manual
2023-01-10doc/manual/src/contributing/hacking.md: Apply suggestionRobert Hensing
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-01-10doc/manual/hacking: Document @docroot@ variableRobert Hensing
2023-01-10doc/manual: Apply suggestions from code reviewRobert Hensing
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-01-10doc/manual: Move the html files back where they were beforeRobert Hensing
... before the link checking "output" was added, bumping the html output into a subdirectory.
2023-01-10doc/manual: Document hacking on the manual linksRobert Hensing
2023-01-10doc/manual: Fix broken internal linksRobert Hensing
The targets I could find.
2023-01-10doc/manual: Introduce @docroot@ as a stable base for includable snippetsRobert Hensing
This way the links are clearly within the manual (ie not absolute paths), while allowing snippets to reference the documentation root reliably, regardless of at which base url they're included.
2023-01-10manual: Check linksRobert Hensing
mdbook-linkcheck is not consistent about its warning setting. It disables some warnings, but not the warnings about lack of fragment checking support; hence the extra filtering.
2023-01-09Add a pointer from "realising" to `nix log`. (#4876)Jeremy Fleischman
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-03move `unsafeDiscardReferences` out of `outputChecks`Naïm Favier
It's not a check.
2023-01-03`unsafeDiscardReferences`Naïm Favier
Adds a new boolean structured attribute `outputChecks.<output>.unsafeDiscardReferences` which disables scanning an output for runtime references. __structuredAttrs = true; outputChecks.out.unsafeDiscardReferences = true; This is useful when creating filesystem images containing their own embedded Nix store: they are self-contained blobs of data with no runtime dependencies. Setting this attribute requires the experimental feature `discard-references` to be enabled.
2023-01-03define the terms "realise" and "valid" for store pathsValentin Gagarin
add links to the glossary definition where the terms are used
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.