diff options
author | Alexander Bantyev <balsoft@balsoft.ru> | 2023-03-23 19:27:41 +0400 |
---|---|---|
committer | Valentin Gagarin <valentin.gagarin@tweag.io> | 2023-03-30 09:46:28 +0200 |
commit | 36b059748d06e39fb3e588463bbc4ddcd2255f27 (patch) | |
tree | c56ec5afaa12e37ababda1132c189f9334338974 /doc/manual/src/language/advanced-attributes.md | |
parent | 84c2c09ec2889d3caf1841140cc2bcb4ab34228b (diff) |
Split nix-env and nix-store documentation per-subcommand
Documentation on "classic" commands with many sub-commands are
notoriously hard to discover due to lack of overview and anchor links.
Additionally the information on common options and environment variables
is not accessible offline in man pages, and therefore often overlooked
by readers.
With this change, each sub-command of nix-store and nix-env gets its
own page in the manual (listed in the table of contents), and each own
man page.
Also, man pages for each subcommand now (again) list common options
and environment variables. While this makes each page quite long and
some common parameters don't apply, this should still make it easier
to navigate as that additional information was not accessible on the
command line at all.
It is now possible to run 'nix-store --<subcommand> --help` to display
help pages for the given subcommand.
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
Diffstat (limited to 'doc/manual/src/language/advanced-attributes.md')
-rw-r--r-- | doc/manual/src/language/advanced-attributes.md | 3 |
1 files changed, 1 insertions, 2 deletions
diff --git a/doc/manual/src/language/advanced-attributes.md b/doc/manual/src/language/advanced-attributes.md index 5a63236e5..3e8c48890 100644 --- a/doc/manual/src/language/advanced-attributes.md +++ b/doc/manual/src/language/advanced-attributes.md @@ -198,8 +198,7 @@ Derivations can declare some infrequently used optional attributes. - `"recursive"`\ The hash is computed over the NAR archive dump of the output - (i.e., the result of [`nix-store - --dump`](../command-ref/nix-store.md#operation---dump)). In + (i.e., the result of [`nix-store --dump`](@docroot@/command-ref/nix-store/dump.md)). In this case, the output can be anything, including a directory tree. |