diff options
author | Théophane Hufschmitt <7226587+thufschmitt@users.noreply.github.com> | 2022-12-08 06:39:13 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-12-08 06:39:13 +0100 |
commit | 1dd7779c7cdca7061e80ebc3b7886a2aa97b0d8a (patch) | |
tree | 00b4ae0eb81b51d920450c034a1e26e0f3f2a4b1 /doc/manual/src | |
parent | f4d6f3ae8fcd10835c3e50339e9caf4b28a98ee5 (diff) | |
parent | ebeaf03558caa62cba6f0bfbd1170dbd5c5944b8 (diff) |
Merge pull request #7379 from fricklerhandwerk/refactor-generate-options
refactor rendering documentation of options
Diffstat (limited to 'doc/manual/src')
-rw-r--r-- | doc/manual/src/command-ref/nix-build.md | 12 | ||||
-rw-r--r-- | doc/manual/src/command-ref/nix-store.md | 3 |
2 files changed, 9 insertions, 6 deletions
diff --git a/doc/manual/src/command-ref/nix-build.md b/doc/manual/src/command-ref/nix-build.md index 49c6f3f55..3a47feaae 100644 --- a/doc/manual/src/command-ref/nix-build.md +++ b/doc/manual/src/command-ref/nix-build.md @@ -53,16 +53,18 @@ All options not listed here are passed to `nix-store --realise`, except for `--arg` and `--attr` / `-A` which are passed to `nix-instantiate`. - - [`--no-out-link`]{#opt-no-out-link}\ + - <span id="opt-no-out-link">[`--no-out-link`](#opt-no-out-link)<span> + Do not create a symlink to the output path. Note that as a result the output does not become a root of the garbage collector, and so - might be deleted by `nix-store - --gc`. + might be deleted by `nix-store --gc`. + + - <span id="opt-dry-run">[`--dry-run`](#opt-dry-run)</span> - - [`--dry-run`]{#opt-dry-run}\ Show what store paths would be built or downloaded. - - [`--out-link`]{#opt-out-link} / `-o` *outlink*\ + - <span id="opt-out-link">[`--out-link`](#opt-out-link)</span> / `-o` *outlink* + Change the name of the symlink to the output path created from `result` to *outlink*. diff --git a/doc/manual/src/command-ref/nix-store.md b/doc/manual/src/command-ref/nix-store.md index 9102aff2d..b712a7463 100644 --- a/doc/manual/src/command-ref/nix-store.md +++ b/doc/manual/src/command-ref/nix-store.md @@ -22,7 +22,8 @@ This section lists the options that are common to all operations. These options are allowed for every subcommand, though they may not always have an effect. - - [`--add-root`]{#opt-add-root} *path*\ + - <span id="opt-add-root">[`--add-root`](#opt-add-root)</span> *path* + Causes the result of a realisation (`--realise` and `--force-realise`) to be registered as a root of the garbage collector. *path* will be created as a symlink to the resulting |