Skip to content

Commit

Permalink
use HTML anchors for config parameters
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
fricklerhandwerk committed Dec 7, 2022
1 parent dfa27e6 commit b8a1ff9
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 7 deletions.
2 changes: 1 addition & 1 deletion doc/manual/generate-options.nix
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ let
let
inherit (optionsInfo.${name}) description documentDefault defaultValue aliases;
result = squash ''
- [`${name}`]{#conf-${name}}
- <span id="conf-${name}">[`${name}`](#conf-${name})</span>
${indent " " body}
'';
Expand Down
12 changes: 7 additions & 5 deletions doc/manual/src/command-ref/nix-build.md
Original file line number Diff line number Diff line change
Expand Up @@ -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*.

Expand Down
3 changes: 2 additions & 1 deletion doc/manual/src/command-ref/nix-store.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit b8a1ff9

Please sign in to comment.