-
-
Notifications
You must be signed in to change notification settings - Fork 14.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
nixos/*: tag manpage references #377184
nixos/*: tag manpage references #377184
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't check every manpage directly, but the ones I did check were present. This looks correct.
@@ -194,7 +194,7 @@ in | |||
DAEMON = mkOption { | |||
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
https://linux.die.net/man/8/master
I didn't think this was real but it is
@@ -546,7 +546,7 @@ in | |||
type = lib.types.lines; | |||
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)`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
@@ -73,7 +73,7 @@ in | |||
}); | |||
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
https://man.openbsd.org/OpenBSD-5.2/CellServDB.5
Disappears from the OpenBSD man pages after 5.2 👀
Please review |
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 -p
for 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.json
with 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 = relaxed
sandbox = true
nix-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.