nixos/*: tag manpage references#377184
Merged
philiptaron merged 4 commits intoNixOS:masterfrom Jan 27, 2025
Merged
Conversation
3a4e2a4 to
b5f6a06
Compare
Made with:
jq <doc/manpage-urls.json 'to_entries[] | "rg -F \"[\(.key)](\(.value))\" nixos/ -l | xe sd -F \"[\(.key)](\(.value))\" \"{manpage}`\(.key)`\""' -r | tr \" \' | bash -x
(requires ripgrep, sd and xe)
b5f6a06 to
5e6998a
Compare
philiptaron
approved these changes
Jan 27, 2025
Contributor
philiptaron
left a comment
There was a problem hiding this comment.
I didn't check every manpage directly, but the ones I did check were present. This looks correct.
| default = { }; | ||
| description = '' | ||
| This section lists long running daemons to start before any SERVICES are spawned. master(8) will ensure that these processes are running, restarting any process which dies or forks. All listed processes will be shutdown when master(8) is exiting. | ||
| This section lists long running daemons to start before any SERVICES are spawned. {manpage}`master(8)` will ensure that these processes are running, restarting any process which dies or forks. All listed processes will be shutdown when {manpage}`master(8)` is exiting. |
Contributor
There was a problem hiding this comment.
https://linux.die.net/man/8/master
I didn't think this was real but it is
| default = ""; | ||
| description = '' | ||
| Additional entries to put verbatim into aliases file, cf. man-page aliases(8). | ||
| Additional entries to put verbatim into aliases file, cf. man-page {manpage}`aliases(8)`. |
Contributor
There was a problem hiding this comment.
Not for this PR, but having a style guide for how to refer to a manpage (man-page? Nothing?) would be nice. @NixOS/documentation-team
| description = '' | ||
| This cell's database server records, added to the global | ||
| CellServDB. See CellServDB(5) man page for syntax. Ignored when | ||
| CellServDB. See {manpage}`CellServDB(5)` man page for syntax. Ignored when |
Contributor
There was a problem hiding this comment.
https://man.openbsd.org/OpenBSD-5.2/CellServDB.5
Disappears from the OpenBSD man pages after 5.2 👀
13 tasks
Member
Author
|
Please review |
This file contains hidden or 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
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.
This is basically the second commit in #377170 on steroids, candidate for #346453
Candidates were made using
and picked with
GIT_DIFF_OPTS='--unified=20' git add -pfor improved context.The second commit was made using
The third commit and onward are manual cleanups and fixes
The next stage is to either (a) expand
doc/manpage-urls.jsonwith more urls or (b) addhttps://linux.die.net/man/as a fallback, or (c) both. (see #208762.)Things done
nix.conf? (See Nix manual)sandbox = relaxedsandbox = truenix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage./result/bin/)Add a 👍 reaction to pull requests you find important.