aboutsummaryrefslogtreecommitdiff
path: root/doc/manual/src/command-ref
AgeCommit message (Collapse)Author
2023-09-06dedent common options listing; one sentence per lineValentin Gagarin
this is a pure reformatting, contents were not changed one sentence per line makes reviewing diffs and making suggestions much more convenient. the indentation was an artifat of the DocBook migration.
2023-09-05Merge pull request #7592 from fricklerhandwerk/nix-store-realiseValentin Gagarin
reword description of how realisation works
2023-09-01Merge branch 'master' into valid_deriver_2Eelco Dolstra
2023-08-31revert some random changeValentin Gagarin
2023-08-31make description open-ended, add TODOValentin Gagarin
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2023-08-31don't invent terms yetValentin Gagarin
2023-08-31more meaningful taglineValentin Gagarin
2023-08-31accommodate "do nothing" branchValentin Gagarin
2023-08-31be more precise about substituting store derivationsValentin Gagarin
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2023-08-31add anchor to `builder`Valentin Gagarin
2023-08-31add reference linkValentin Gagarin
2023-08-31remove abstract descriptionValentin Gagarin
2023-08-31reword introductory sentenceValentin Gagarin
2023-08-31remove superfluous wordValentin Gagarin
2023-08-31reword description of how realisation worksValentin Gagarin
2023-08-28Document nix-prefetch-url defaults (#8878)Silvan Mosberger
2023-08-24add nix-store --query --valid-derivers commandGuillaume Girol
notably useful when nix-store --query --deriver returns a non-existing path. Co-authored-by: Felix Uhl <iFreilicht@users.noreply.github.com>
2023-07-19list moving parts of channelsValentin Gagarin
2023-07-19revert channel files overviewValentin Gagarin
2023-07-19remove redundant information from channel profile descriptionValentin Gagarin
2023-07-19remove the Channels sectionValentin Gagarin
this is a how-to guide which should not be in the reference manual. it also refers to `nix-env`, which should not be the first thing readers of the reference manual encounter, as it behaves very differently in spirit from the rest of Nix. slightly reword the documentation to be more concise and informative.
2023-06-22Better document build failure exit codesJohn Ericson
- Improved API docs from comment - Exit codes are for `nix-build`, not just `nix-store --release` - Make note in tests so the magic numbers are not surprising Picking up where #8387 left off.
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-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-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-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-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-17Merge pull request #8337 from fricklerhandwerk/channel-filesJohn Ericson
list files used by `nix-channel` on its own man page
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-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-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-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-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-05remove incorrect referenceValentin Gagarin
the semantics are not explained in the referenced section any more, they have been moved to the documentation for common options in the new CLI [0]. [0]: 703d863a48f549b2626382eda407ffae779f8725
2023-04-05Merge pull request #7849 from milahu/fix-man-nix-shellValentin Gagarin
docs: fix nix-shell commands