aboutsummaryrefslogtreecommitdiff
path: root/doc/manual/src/command-ref
AgeCommit message (Collapse)Author
2023-02-10Merge pull request #5588 from tweag/balsoft/xdgThéophane Hufschmitt
Follow XDG Base Directory standard
2023-02-10A setting to follow XDG Base Directory standardAlexander Bantyev
XDG Base Directory is a standard for locations for storing various files. Nix has a few files which seem to fit in the standard, but currently use a custom location directly in the user's ~, polluting it: - ~/.nix-profile - ~/.nix-defexpr - ~/.nix-channels This commit adds a config option (use-xdg-base-directories) to follow the XDG spec and instead use the following locations: - $XDG_STATE_HOME/nix/profile - $XDG_STATE_HOME/nix/defexpr - $XDG_STATE_HOME/nix/channels If $XDG_STATE_HOME is not set, it is assumed to be ~/.local/state. Co-authored-by: Théophane Hufschmitt <7226587+thufschmitt@users.noreply.github.com> Co-authored-by: Tim Fenney <kodekata@gmail.com> Co-authored-by: pasqui23 <pasqui23@users.noreply.github.com> Co-authored-by: Artturin <Artturin@artturin.com> Co-authored-by: John Ericson <Ericson2314@Yahoo.com>
2023-01-30manual: Document that the store timestamp is now 1, not 0Anders Kaseorg
Commit 14bc3ce3d6d5745717fa19b8b43b5fdd117ff757 (0.13~43) changed the timestamps in the Nix store from 0 to 1. Update the nix-store man page to match. Signed-off-by: Anders Kaseorg <andersk@mit.edu>
2023-01-24doc: fix anchor links in and to glossaryFelix Uhl
2023-01-20Merge pull request #7490 from fricklerhandwerk/doc-realiseThéophane Hufschmitt
define the terms "realise" and "valid" for store paths
2023-01-10Merge pull request #7541 from hercules-ci/check-manual-linksRobert Hensing
Check links in the manual
2023-01-10doc/manual: Fix broken internal linksRobert Hensing
The targets I could find.
2023-01-09Add a pointer from "realising" to `nix log`. (#4876)Jeremy Fleischman
2023-01-03define the terms "realise" and "valid" for store pathsValentin Gagarin
add links to the glossary definition where the terms are used
2022-12-21link "store derivation" to glossary definitionValentin Gagarin
2022-12-12Merge pull request #7421 from edolstra/lazy-trees-trivial-changesEelco Dolstra
Trivial changes from the lazy-trees branch
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-08Merge pull request #7379 from fricklerhandwerk/refactor-generate-optionsThéophane Hufschmitt
refactor rendering documentation of options
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-07Trivial changes from the lazy-trees branchEelco Dolstra
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-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).
2022-09-28nix-copy-closure: improve wordingSolene Rapenne
2022-08-04manual: remove "Writing Nix Expressions" chapterValentin Gagarin
it is out of date, all over the place in level of detail, is really about `nixpkgs`, and in general instructions should not be part of a reference manual. also: - update redirects and internal links - use "Nix language" consistently
2022-07-10Fix logical and typographical errors in nix-env man pagelaalsaas
2022-06-14Add disambiguation to man pageHugo Osvaldo Barrera
This should help future lost newcomers like myself understand where to find the docs for both of these commands and how they differ.
2022-05-27Merge branch 'doc-redirects' of https://github.com/jtojnar/nixEelco Dolstra
2022-05-26doc: Manually insert some anchorsJan Tojnar
2022-05-26doc: Add anchors to long listsJan Tojnar
Added using the following sed scripts: - For command-ref/opt-common.md: s~- `(--?)([^`]+)`~- [`\1\2`]{#opt-\2}~g - For expressions/builtin-constants.md: s~- `(builtins\.?)([^`]+)`~- [`\1\2`]{#builtins-\2}~g - For expressions/advanced-attributes.md s~^ - `([^`]+)`~ - [`\1`]{#adv-attr-\1}~g and manually adjusted outputHashAlgo & outputHashMode. - For glossary.md s~^ - (`([^`]+)`|(.+)) ?\\~ - [\1]{#gloss-\2\3}\\~g; s~(gloss-\w+) ~\1-~g and manually adjusted anchors for Nix expression, user environment, NAR, ∅ and ε. - For command-ref/env-common.md s~^ - `([^`]+)`~ - [`\1`]{#env-\1}~g'
2022-05-26Tweak IN_NIX_SHELL descriptionEelco Dolstra
2022-02-23Precise the doc for `--include-outputs`Théophane Hufschmitt
Make it explicit that it only includes the existing outputs and not the ones that haven’t been realised
2022-01-21Correct NIX_BUILD_PATH default descriptionRoss Light
Source: https://github.com/NixOS/nix/blob/067076287bf601f8fa2ffe4feff3057b96fa5be8/src/nix-build/nix-build.cc#L362-L381
2021-11-18Merge pull request #5585 from jtojnar/env-aEelco Dolstra
doc: De-emphasize nix-env without -A
2021-11-17doc: De-emphasize nix-env without -AJan Tojnar
The manual uses `nix-env -i` without `-A` prominently, teaching a bad practice to newcomers.
2021-11-17Fix XDG_CONFIG_DIRS fallbackJan Tojnar
According to XDG Base Directory Specification, it should fall back to /etc/xdg when the env var is not present.
2021-11-04docs: Correct fallback user config pathJan Tojnar
This is in line with XDG Base Directory Specification, where ~/.config is supposed to be used when XDG_CONFIG_HOME is unset. It also better matches the reality, where ~/.config/nix.conf does not seem to be used.
2021-11-03Fix typosDimitris Apostolou
2021-11-02command-ref/nix-shell: fix --pure, --keepSimon Legner
2021-10-17Clarify that not all nix packages will use the default build phasesJohn Chapman
2021-10-09Clarify that not all nix packages will use the default build phasesJohn Chapman
2021-06-03Improve explanation of NIX_PATH prefix syntaxKeshav Kini
The previous wording seemed to imply that the "channel:" syntax would resolve to a github archive URL, which is not the case.
2021-05-11doc/nix-shell: Remove outdated bashrc informationLinus Heckemann
This behaviour was removed in 65f6d5db6f5ef2724a3dc03e1773c510123287f1.
2021-04-23Replace the trailing markdown spaces by a backslashregnat
They are equivalent according to <https://spec.commonmark.org/0.29/#hard-line-breaks>, and the trailing spaces tend to be a pain (because the make git complain, editors tend to want to remove them − the `.editorconfig` actually specifies that − etc..).
2021-03-26Fix some typosEelco Dolstra
Fixes #4671.
2021-03-06remove doc for obsolete --no-build-hook flagTravis A. Everett
`--no-build-hook` appears to have been removed in 25f32625e2f2a3a1e1b3a3811da82f21c3a3b880
2021-02-16Update doc/manual/src/command-ref/nix-shell.mdMauricio Scheffer
Co-authored-by: Cole Helbling <cole.e.helbling@outlook.com>
2021-02-16Fix Haskell exampleMauricio Scheffer
http://nixos.org redirects to https://nixos.org and apparently the HTTP library doesn't follow the redirect, so the output is empty. When defining https in the request it crashes because the library doesn't seem to support https. So this switches the example to a different http library.
2021-01-11TweakEelco Dolstra
2020-10-30Merge pull request #4202 from hercules-ci/nix-shell-docEelco Dolstra
Nix shell doc
2020-10-30nix-shell.md: Extend shellHook exampleRobert Hensing
2020-10-30nix-shell.md: evaluated -> runRobert Hensing
Use "run" to avoid confusion with Nix evaluation. "evaluated" was intended to reference bash eval but it's ambiguous.
2020-10-29Generalize extra-* settingsEelco Dolstra
This removes the extra-substituters and extra-sandbox-paths settings and instead makes every array setting extensible by setting "extra-<name> = <value>" in the configuration file or passing "--<name> <value>" on the command line.
2020-10-25Add sha512 to hashAlgo listings in manpages (#4186)tnias