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

mandoc: change OSNAME to Nixpkgs to match groff #217705

Merged
merged 2 commits into from
Feb 23, 2023

Conversation

sternenseemann
Copy link
Member

@sternenseemann sternenseemann commented Feb 22, 2023

Description of changes
Things done
  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandbox = true set in nix.conf? (See Nix manual)
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 23.05 Release Notes (or backporting 22.11 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md.

In general the man pages do not care what OS and manual they are shipped
with, so they don't get to choose the names of them. We were tempted to
do so, as we had inconsistently chosen OS names for the mandoc and
man-db/groff implementations. Since this has been rectified since, we
can just drop this boilerplate from the man pages.
Copy link
Contributor

@pennae pennae left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good. we'd prefer to keep the nixos-specific manpages at saying they're for nixos, but we're fine having it either way as long as it's consistent.

@pennae
Copy link
Contributor

pennae commented Feb 22, 2023

side note for completeness:

r'''.TH "CONFIGURATION\&.NIX" "5" "01/01/1980" "NixOS" "NixOS Reference Pages"''',
also hard-codes nixos into a manpage, but since so far this manpage is generated by a nixos module for a nixos system we'd argue it shouldn't be changed (and when it is, changed to being a free parameter that the module sets to NixOS)

@sternenseemann
Copy link
Member Author

@pennae I was contemplating making a mandoc-nixos, man-db-nixos attribute that is used in the respective NixOS modules, so that the entry at the bottom makes sense – could also be nice for generating the HTML pages at some point for the website/manual.

In general, I do feel that if nixos-install(8) was included in OpenBSD, the thing at the bottom should probably read OpenBSD for better or worse as it's the “normal” way of doing things.

@pennae
Copy link
Contributor

pennae commented Feb 23, 2023

@sternenseemann not sure about that to be honest, having these variants would introduce a rendering discrepancy depending on how mandoc/groff are installed (seeing how nix{ ,-}shell takes priority over systemPackages). we'd rather have everything consistent independent of how the renderer was installed. using a special package specifically for rendering html pages to be published online sounds reasonable though.

the only thing we really want to not change at this point is configuration.nix.5 due to its specificity, everything else as you've mentioned can really run and be useful anywhere.

@sternenseemann sternenseemann merged commit d1fa5dd into NixOS:master Feb 23, 2023
@sternenseemann sternenseemann deleted the mandoc-nixpkgs branch February 23, 2023 19:53
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

3 participants