always show anchors on setting listings #8942
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fricklerhandwerk
force-pushed
the
option-anchors
branch
5 times, most recently
from
ac2c22e
to
1ac1908
Compare
fricklerhandwerk
force-pushed
the
option-anchors
branch
from
1ac1908
to
c5b4959
Compare
Ericson2314
reviewed
Sep 29, 2023
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/2023-09-29-nix-team-meeting-minutes-90/33774/1 |
|
@Ericson2314 fixed. |
refactor the templates for readability
the `term` output mode leaves inline HTML around verbatim, while `nroff` mode (used for `man` pages) does not. the correct solution would be to pre-render all output with a more benign tool so we have less liabilities in our own code, but this has to do for now.
fricklerhandwerk
force-pushed
the
option-anchors
branch
from
73d4b9e
to
e0e47c0
Compare
fricklerhandwerk
added
backport 2.18-maintenance
fricklerhandwerk
removed
backport 2.17-maintenance
backport 2.18-maintenance
This was referenced Nov 10, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
The
nix store-infomanual page lists store parameters without anchor links. The page is quite long and one can't point readers to a particular parameter, many of which are non-trivial to describe or specific to a particular store.Context
This change is also a cleanup refactoring of the manual rendering code. It moves the expressions for formatting general settings listings and the store-specific documentation into separate files, and recovers
utils.nixto be a little helper library that is not specific to any particular use case in the manual rendering code.Other than that, the user-visible change is insignificant: it just adds anchors to the list items, with a prefix derived from the store name.
Priorities
Add 👍 to pull requests you find important.