Navigation Menu

Skip to content
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

groff: set "operating system" for mdoc pages #102029

Merged
merged 1 commit into from Nov 1, 2020
Merged

Conversation

alyssais
Copy link
Member

Prior to this change, man pages from Nixpkgs written using the mdoc(7)
macros would start like this:

NC(1)                   BSD General Commands Manual                   NC(1)

and end like this:

BSD                          December 27, 2018                          BSD

No matter what operating system they were run on.

It's far more accurate to say "Nixpkgs General Commands Manual", so
with this patch we configure groff to do just that. The variable is
called "operating-system", but I think it makes more sense to say
"Nixpkgs" than "NixOS" or something, because packages from Nixpkgs can
run on lots of operating systems, and the important thing is that the
package is from Nixpkgs.

Motivation for this change
Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.

Prior to this change, man pages from Nixpkgs written using the mdoc(7)
macros would start like this:

    NC(1)                   BSD General Commands Manual                   NC(1)

and end like this:

    BSD                          December 27, 2018                          BSD

No matter what operating system they were run on.

It's far more accurate to say "Nixpkgs General Commands Manual", so
with this patch we configure groff to do just that.  The variable is
called "operating-system", but I think it makes more sense to say
"Nixpkgs" than "NixOS" or something, because packages from Nixpkgs can
run on lots of operating systems, and the important thing is that the
package is from Nixpkgs.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants