aboutsummaryrefslogtreecommitdiff
path: root/doc/manual
AgeCommit message (Collapse)Author
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-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-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>
2023-05-15list files used by `nix-channel`Valentin Gagarin
2023-05-15Merge pull request #8141 from tweag/user-files-docJohn Ericson
Document user files of nix
2023-05-15refactor: Join commands to remove filesVictor Engmark
2023-05-15docs: Mention more files referenced by the installerVictor Engmark
`/etc/bash.bashrc` is backed up as `/etc/bash.bashrc.backup-before-nix`, but since other changes might have been introduced in the meantime we can't just tell the user to revert.
2023-05-15docs: Remove references to non-existing filesVictor Engmark
At least on Ubuntu 22.04, these files are not created as part of a multi- user installation.
2023-05-15docs: Sort files by nameVictor Engmark
2023-05-15docs: Remove Nix profile content from correct directoryVictor Engmark
At least on Ubuntu 22.04, the Nix installer creates `/etc/profile.d/nix.sh`, not `/etc/profile/nix.sh`.
2023-05-15docs: Remove redundant uninstall commandVictor Engmark
`sudo systemctl disable nix-daemon.socket nix-daemon.service` removes these files already.
2023-05-14Merge pull request #8328 from urbas/max-substitution-jobsValentin Gagarin
2023-05-14`max-substitution-jobs` release note entryMatej Urbas
2023-05-12Describe the or operation on attribute sets slightly moreAna Hobden
2023-05-12Update doc/manual/src/SUMMARY.md.inAlexander Bantyev
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-05-11reword introduction to built-in functionsValentin Gagarin
add anchor to `builtins.derivation` and list some built-in functions that are exposed in the global scope. I decided not to list everything, because we probably don't want to encourage people using them that way.
2023-05-11reword documentation on `builtins`Valentin Gagarin
- add anchor to `builtins` - add type information - reword description of `builtins` to offer more information concisely
2023-05-11do not indent markdown listValentin Gagarin
2023-05-03add redirect to track moved uninstall sectionValentin Gagarin
2023-05-03doc rendering: add functions to scope explicitly (#7378)Valentin Gagarin
* doc rendering: add functions to scope explicitly this especially helps beginners with code readability, since the origin of names is always immediately visible.
2023-04-28display documentation on manifest files separatelyValentin Gagarin
it's probably better not to show the manifest file documentation in the command-specific pages, because these are implementation details that are not really practically useful. this means no additional hassle for building the manual, but clutters the table of contents a bit.
2023-04-28move uninstall instructions to a separate pageValentin Gagarin
placed in a subsection of the binary install, the instructions are hard to find. putting them in a separate page that is shown in the table of contents should make it easier for users to find what they need when they need it.
2023-04-26move manifest information to the bottom of the pageValentin Gagarin
2023-04-26move compatibility info to `nix profile` docsValentin Gagarin
2023-04-26increase heading level Valentin Gagarin
otherwise the headings won't match at the point where they are included. this is a bit hacky and brittle, but works for now.
2023-04-26update description on how profiles work Valentin Gagarin
adapt to the example listing
2023-04-26fix typos and wordingValentin Gagarin
2023-04-26add colons to connect listings with descriptionsValentin Gagarin
2023-04-26list information regular users firstValentin Gagarin
this is to make it consistent everywhere
2023-04-26Document user files of nixAlexander Bantyev
2023-04-18Update installing-binary.mdMichael Utz
2023-04-17Documentation: fix typo for `Nix database` link in manualNoah Snelson
Fixes broken link for `Nix database` anchor in the Glossary page of the Nix manual.
2023-04-17Merge pull request #7514 from fricklerhandwerk/opt-IValentin Gagarin
remove incorrect reference to `NIX_PATH` documentation
2023-04-17use @docroot@ linkValentin Gagarin
2023-04-17add link to `nix-conf` settingValentin Gagarin
Co-authored-by: John Ericson <git@JohnEricson.me>
2023-04-16Mark experimental configuration settings programmaticallyJohn Ericson
Fix #8162 The test is changed to compare `nlohmann::json` values, not strings of dumped JSON, which allows us to format things more nicely.
2023-04-16Add `optionalString` to manual Nix lang utilitiesJohn Ericson
Use it everywhere it could be also.
2023-04-14Merge pull request #7864 from obsidiansystems/quickstart-long-optionsJohn Ericson
Use long options instead of short ones in the "quick start"
2023-04-14Start cross-referencing experimental featuresJohn Ericson
- Create a glossary entry for experimental features. - Have the man page experimental feature notice link `nix-commmand`. (Eventually this should be programmed, based on whether the command is experimental, and if so what experimental feature does it depend on.) - Document which installables depend on which experimental features. I tried to use the same style (bold warning and block quote) that the top of the man page uses. Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-04-11Release notesEelco Dolstra
2023-04-11Merge pull request #7798 from peeley/list-experimental-featuresEelco Dolstra
Documentation: list experimental features in manual
2023-04-09Single page for experimental feature descriptionsJohn Ericson
As requested by @fricklerhandwerk.
2023-04-07Add release notes for `nix derivation {add,show}`John Ericson
2023-04-07`nix show-derivation` -> `nix derivation show`John Ericson