aboutsummaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2023-06-22Merge pull request #8565 from obsidiansystems/profile-delete-docsJohn Ericson
Clarify docs on deleting generations, including fixing a mistake
2023-06-22Merge pull request #8556 from fricklerhandwerk/hacking-headingsValentin Gagarin
hacking guide: use more self-descriptive section headings
2023-06-21Clarify docs on deleting generations, including fixing a mistakeJohn Ericson
Deleting store info corrected (there is a foot-gun in Nix with `--delete-generations old`!) Also a few things are cleaned up based on feedback. Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io> Co-authored-by: Eelco Dolstra <edolstra@gmail.com>
2023-06-21do not use "target", as it's a loaded term in the domain of compilersValentin Gagarin
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2023-06-21add redirects to changed anchorsValentin Gagarin
2023-06-21fix anchor linkValentin Gagarin
2023-06-20use more self-descriptive section headingsValentin Gagarin
2023-06-20Merge pull request #8532 from fricklerhandwerk/nix.conf-sectionsValentin Gagarin
split nix.conf man page into sections
2023-06-20clarify setting options on the command lineValentin Gagarin
2023-06-20clarify read order for configuration settingsValentin Gagarin
2023-06-20split configuration file page into sectionsfricklerhandwerk
this makes it easier to scan for specific information, such as the format of command line flags
2023-06-20add links to environment variables documentationfricklerhandwerk
2023-06-19redirect old platform uninstall instruction linksTravis A. Everett
Uninstall instructions were moved to their own page in #8267. The overall section link was redirected in #8286, but platform-specific links (which I give out frequently when I triage installer trouble) weren't included.
2023-06-19Add more links in nix-build documentation (#8545)Silvan Mosberger
* Add more links in nix-build documentation Co-authored-by: John Ericson <git@JohnEricson.me>
2023-06-19Split out worker protocol template definitions from declarationsJohn Ericson
This is generally a fine practice: Putting implementations in headers makes them harder to read and slows compilation. Unfortunately it is necessary for templates, but we can ameliorate that by putting them in a separate header. Only files which need to instantiate those templates will need to include the header with the implementation; the rest can just include the declaration. This is now documenting in the contributing guide. Also, it just happens that these polymorphic serializers are the protocol agnostic ones. (Worker and serve protocol have the same logic for these container types.) This means by doing this general template cleanup, we are also getting a head start on better indicating which code is protocol-specific and which code is shared between protocols.
2023-06-18Add description for file system objects (#8500)Valentin Gagarin
While this is not actually a notion in the implementation, it is explicitly described in the thesis and quite important for understanding how the store works. Co-authored-by: John Ericson <git@JohnEricson.me> Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2023-06-18Merge pull request #8472 from NixOS/nix-language-purposeJohn Ericson
Refine wording on the purpose of the Nix language
2023-06-17Fix wikipedia links (#8533)Christina Sørensen
2023-06-16Merge pull request #8477 from edolstra/tarball-flake-redirectsEelco Dolstra
Tarball flake improvements
2023-06-16Apply suggestions from code reviewEelco Dolstra
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2023-06-16Add docsEelco Dolstra
2023-06-15make domain-specificity more specificValentin Gagarin
also slightly reword the purpose statement to introduce (and explain) derivations right away.
2023-06-15Merge pull request #8351 from obsidiansystems/delete-profiles-tests-docsJohn Ericson
Expanding tests and docs relating to deleting profiles
2023-06-14Improve `nix-collect-garbage` docsJohn Ericson
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-06-14Improve `nix-env --delete-generations` docsJohn Ericson
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-06-14Fixup description of substituters (#8291)Valentin Gagarin
Introduce what substituters "are" in the configuration option entry. Remove arbitrary line breaks for easier editing in the future. Link glossary some more. Co-authored-by: Robert Hensing <roberth@users.noreply.github.com> Co-authored-by: John Ericson <git@JohnEricson.me>
2023-06-14Merge pull request #8488 from Mic92/update-requirementsJohn Ericson
nix actually needs c++20 now
2023-06-14Merge pull request #4803 from ShamrockLee/nix-channel-list-generationsJohn Ericson
Add `nix-channel --list-generations`
2023-06-10nix actually needs c++20 nowJörg Thalheim
2023-06-08refine wording on the purpose of the Nix languageValentin Gagarin
packages and configurations are not really a concept in Nix or the Nix language. the idea of transforming files into other files clearly captures what it's all about, and the new phrasing should make the term "derivation" more obvious both in terms of meaning and origin.
2023-06-02Merge pull request #8317 from fricklerhandwerk/doc-identifierThéophane Hufschmitt
document identifier syntax for attribute sets
2023-06-02Add a release note for `nix-channel --list-generations`Théophane Hufschmitt
2023-06-02Add nix-channel --list-generationsShamrock Lee
Add support to --list-generations as another way to say nix-env --profile /nix/var/nix/profiles/per-user/$USER/channels --list-generations the way we did for nix-channel --rollback [generation id]
2023-05-31TypoEelco Dolstra
2023-05-31Release notesEelco Dolstra
2023-05-31Merge pull request #8421 from fricklerhandwerk/doc-replaceStringsEelco Dolstra
update documentation according to release notes
2023-05-31Merge pull request #8318 from fricklerhandwerk/doc-currentTimeValentin Gagarin
document `builtins.currentTime`
2023-05-31Merge pull request #8413 from doronbehar/doc/distributed-builds/clearer-warningValentin Gagarin
distributed-builds.md: Clarify warning ssh access requirements
2023-05-31rewrap lines to use one line per sentenceValentin Gagarin
this makes future reviews easier as it reduces diff noise
2023-05-31distributed-builds.md: Clarify warning ssh access requirementsDoron Behar
2023-05-30link to mentioned builtinValentin Gagarin
2023-05-25primops: lazy evaluation of replaceStrings replacementspolykernel
The primop `builtins.replaceStrings` currently always strictly evaluates the replacement strings, however time and space are wasted for their computation if the corresponding pattern do not occur in the input string. This commit makes the evaluation of the replacement strings lazy by deferring their evaluation to when the corresponding pattern are matched and memoize the result for efficient retrieval on subsequent matches. The testcases for replaceStrings was updated to check for lazy evaluation of the replacements. A note was also added in the release notes to document the behavior change.
2023-05-17Merge pull request #8337 from fricklerhandwerk/channel-filesJohn Ericson
list files used by `nix-channel` on its own man page
2023-05-17Merge pull request #8358 from fricklerhandwerk/output-addressed-referencesJohn Ericson
fix wording on output-addressed store objects
2023-05-17fix wording on output-addressed store objectsValentin Gagarin
hashing is an implementation detail. add references to the other terms.
2023-05-17add cross-references to pure evaluation modeValentin Gagarin
use consistent wording everywhere. add some details on the configuration option documentation.
2023-05-17document `builtins.currentTime`Valentin Gagarin
2023-05-17document identifier syntax for attribute setsValentin Gagarin
it's more likely for readers to find it right there. this also slightly rewords examples to make them stand out better. in the long run there probably needs to be a dedicated section on formal syntax, and better highlighting of examples.
2023-05-17Convert short nix options to long onesAlexander Schmolck
e.g. nix-env -e subversion => nix-env --uninstall subversion The aim is to make the documentation less cryptic for newcomers and the long options are more self-documenting. The change was made with the following script: <https://github.com/aschmolck/convert-short-nix-opts-to-long-ones> and sanity checked visually.
2023-05-15Reword info on XDG base dirs (#8338)Valentin Gagarin
This gives some more context and should clarify why it works that way. Also link it from the section on `NIX_USER_CONF_FILES`. Co-authored-by: John Ericson <git@JohnEricson.me>