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

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

merged 1 commit into from Nov 1, 2020

Conversation

@alyssais
Copy link
Member

@alyssais alyssais commented Oct 29, 2020

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.
@FRidh FRidh merged commit 7bf3d77 into NixOS:staging Nov 1, 2020
19 of 20 checks passed
19 of 20 checks passed
@github-actions
tests
Details
@github-actions
action
Details
@ofborg
groff, groff.passthru.tests on x86_64-darwin
Details
@ofborg
Evaluation Performance Report Evaluator Performance Report
Details
@github-actions
Wait for ofborg
Details
@ofborg
grahamcofborg-eval ^.^!
Details
@ofborg
grahamcofborg-eval-check-maintainers matching changed paths to changed attrs...
Details
@ofborg
grahamcofborg-eval-check-meta config.nix: checkMeta = true
Details
@ofborg
grahamcofborg-eval-darwin nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="2c6744c"; rev="2c6744ce7b2b0c654b4e7f0f5bc932589f6556cd"; } ./pkgs/t
Details
@ofborg
grahamcofborg-eval-lib-tests nix-build --arg pkgs import ./. {} ./lib/tests/release.nix
Details
@ofborg
grahamcofborg-eval-nixos nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="2c6744c"; rev="2c6744ce7b2b0c654b4e7f0f5bc932589f6556cd"; } ./nixos/
Details
@ofborg
grahamcofborg-eval-nixos-manual nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="2c6744c"; rev="2c6744ce7b2b0c654b4e7f0f5bc932589f6556cd"; } ./nixos/
Details
@ofborg
grahamcofborg-eval-nixos-options nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="2c6744c"; rev="2c6744ce7b2b0c654b4e7f0f5bc932589f6556cd"; } ./nixos/
Details
@ofborg
grahamcofborg-eval-nixpkgs-manual nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="2c6744c"; rev="2c6744ce7b2b0c654b4e7f0f5bc932589f6556cd"; } ./pkgs/t
Details
@ofborg
grahamcofborg-eval-nixpkgs-tarball nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="2c6744c"; rev="2c6744ce7b2b0c654b4e7f0f5bc932589f6556cd"; } ./pkgs/t
Details
@ofborg
grahamcofborg-eval-nixpkgs-unstable-jobset nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="2c6744c"; rev="2c6744ce7b2b0c654b4e7f0f5bc932589f6556cd"; } ./pkgs/t
Details
@ofborg
grahamcofborg-eval-package-list nix-env -qa --json --file .
Details
@ofborg
grahamcofborg-eval-package-list-no-aliases nix-env -qa --json --file . --arg config { allowAliases = false; }
Details
@ofborg
groff, groff.passthru.tests on aarch64-linux Success
Details
@ofborg
groff, groff.passthru.tests on x86_64-linux Success
Details
@alyssais alyssais deleted the alyssais:groff branch Apr 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants