From 43d5400befbd0c9dd3b5629de0fac6334fc8f4de Mon Sep 17 00:00:00 2001 From: sternenseemann Date: Wed, 22 Feb 2023 16:23:20 +0100 Subject: [PATCH 1/2] mandoc: change OSNAME to Nixpkgs to match groff See also * https://github.com/NixOS/nixpkgs/pull/214307 * https://github.com/NixOS/nixpkgs/pull/213256 --- pkgs/tools/misc/mandoc/default.nix | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pkgs/tools/misc/mandoc/default.nix b/pkgs/tools/misc/mandoc/default.nix index 96c04c092b047e8..e8553b7f9e58172 100644 --- a/pkgs/tools/misc/mandoc/default.nix +++ b/pkgs/tools/misc/mandoc/default.nix @@ -24,7 +24,7 @@ stdenv.mkDerivation rec { configureLocal = '' MANPATH_DEFAULT="/run/current-system/sw/share/man" MANPATH_BASE="$MANPATH_DEFAULT" - OSNAME="NixOS" + OSNAME="Nixpkgs" PREFIX="$out" LD_OHASH="-lutil" # Use symlinks instead of hardlinks (more commonly used in nixpkgs) From 3d11c37f79613c103e3eec1c6699b6ff10e85371 Mon Sep 17 00:00:00 2001 From: sternenseemann Date: Wed, 22 Feb 2023 16:30:04 +0100 Subject: [PATCH 2/2] nixos/doc: don't prescribe OS / manual name 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. --- nixos/doc/manual/manpages/nixos-build-vms.8 | 8 ++------ nixos/doc/manual/manpages/nixos-enter.8 | 8 ++------ nixos/doc/manual/manpages/nixos-generate-config.8 | 8 ++------ nixos/doc/manual/manpages/nixos-install.8 | 8 ++------ nixos/doc/manual/manpages/nixos-option.8 | 8 ++------ nixos/doc/manual/manpages/nixos-rebuild.8 | 8 ++------ nixos/doc/manual/manpages/nixos-version.8 | 8 ++------ 7 files changed, 14 insertions(+), 42 deletions(-) diff --git a/nixos/doc/manual/manpages/nixos-build-vms.8 b/nixos/doc/manual/manpages/nixos-build-vms.8 index abf06b5dd59625b..6a8f2c42eddfaa9 100644 --- a/nixos/doc/manual/manpages/nixos-build-vms.8 +++ b/nixos/doc/manual/manpages/nixos-build-vms.8 @@ -1,10 +1,6 @@ .Dd January 1, 1980 -.\" nixpkgs groff will use Nixpkgs as the OS in the title by default, taking it from -.\" doc-default-operating-system. mandoc doesn't have this register set by default, -.\" so we can use it as a groff/mandoc switch. -.ie ddoc-default-operating-system .Dt nixos-build-vms \&8 "NixOS System Manager's Manual" -.el .Dt nixos-build-vms 8 -.Os NixOS +.Dt nixos-build-vms 8 +.Os .Sh NAME .Nm nixos-build-vms .Nd build a network of virtual machines from a network of NixOS configurations diff --git a/nixos/doc/manual/manpages/nixos-enter.8 b/nixos/doc/manual/manpages/nixos-enter.8 index bc8df31e5f2d8e0..646f92199d62fd6 100644 --- a/nixos/doc/manual/manpages/nixos-enter.8 +++ b/nixos/doc/manual/manpages/nixos-enter.8 @@ -1,10 +1,6 @@ .Dd January 1, 1980 -.\" nixpkgs groff will use Nixpkgs as the OS in the title by default, taking it from -.\" doc-default-operating-system. mandoc doesn't have this register set by default, -.\" so we can use it as a groff/mandoc switch. -.ie ddoc-default-operating-system .Dt nixos-enter \&8 "NixOS System Manager's Manual" -.el .Dt nixos-enter 8 -.Os NixOS +.Dt nixos-enter 8 +.Os .Sh NAME .Nm nixos-enter .Nd run a command in a NixOS chroot environment diff --git a/nixos/doc/manual/manpages/nixos-generate-config.8 b/nixos/doc/manual/manpages/nixos-generate-config.8 index 8b9bb4d42483bf1..1b95599e156ae1a 100644 --- a/nixos/doc/manual/manpages/nixos-generate-config.8 +++ b/nixos/doc/manual/manpages/nixos-generate-config.8 @@ -1,10 +1,6 @@ .Dd January 1, 1980 -.\" nixpkgs groff will use Nixpkgs as the OS in the title by default, taking it from -.\" doc-default-operating-system. mandoc doesn't have this register set by default, -.\" so we can use it as a groff/mandoc switch. -.ie ddoc-default-operating-system .Dt nixos-generate-config \&8 "NixOS System Manager's Manual" -.el .Dt nixos-generate-config 8 -.Os NixOS +.Dt nixos-generate-config 8 +.Os .Sh NAME .Nm nixos-generate-config .Nd generate NixOS configuration modules diff --git a/nixos/doc/manual/manpages/nixos-install.8 b/nixos/doc/manual/manpages/nixos-install.8 index dc0a5da275d88ab..c6c8ed15224d360 100644 --- a/nixos/doc/manual/manpages/nixos-install.8 +++ b/nixos/doc/manual/manpages/nixos-install.8 @@ -1,10 +1,6 @@ .Dd January 1, 1980 -.\" nixpkgs groff will use Nixpkgs as the OS in the title by default, taking it from -.\" doc-default-operating-system. mandoc doesn't have this register set by default, -.\" so we can use it as a groff/mandoc switch. -.ie ddoc-default-operating-system .Dt nixos-install \&8 "NixOS System Manager's Manual" -.el .Dt nixos-install 8 -.Os NixOS +.Dt nixos-install 8 +.Os .Sh NAME .Nm nixos-install .Nd install bootloader and NixOS diff --git a/nixos/doc/manual/manpages/nixos-option.8 b/nixos/doc/manual/manpages/nixos-option.8 index 79cc113cfaf2d60..28438b03580b158 100644 --- a/nixos/doc/manual/manpages/nixos-option.8 +++ b/nixos/doc/manual/manpages/nixos-option.8 @@ -1,10 +1,6 @@ .Dd January 1, 1980 -.\" nixpkgs groff will use Nixpkgs as the OS in the title by default, taking it from -.\" doc-default-operating-system. mandoc doesn't have this register set by default, -.\" so we can use it as a groff/mandoc switch. -.ie ddoc-default-operating-system .Dt nixos-option \&8 "NixOS System Manager's Manual" -.el .Dt nixos-option 8 -.Os NixOS +.Dt nixos-option 8 +.Os .Sh NAME .Nm nixos-option .Nd inspect a NixOS configuration diff --git a/nixos/doc/manual/manpages/nixos-rebuild.8 b/nixos/doc/manual/manpages/nixos-rebuild.8 index 8ff59d6da9cfb80..64bbbee411d7fd9 100644 --- a/nixos/doc/manual/manpages/nixos-rebuild.8 +++ b/nixos/doc/manual/manpages/nixos-rebuild.8 @@ -1,10 +1,6 @@ .Dd January 1, 1980 -.\" nixpkgs groff will use Nixpkgs the OS in the title by default, taking it from -.\" doc-default-operating-system. mandoc doesn't have this register set by default, -.\" so we can use it as a groff/mandoc switch. -.ie ddoc-default-operating-system .Dt nixos-rebuild \&8 "NixOS System Manager's Manual" -.el .Dt nixos-rebuild 8 -.Os NixOS +.Dt nixos-rebuild 8 +.Os .Sh NAME .Nm nixos-rebuild .Nd reconfigure a NixOS machine diff --git a/nixos/doc/manual/manpages/nixos-version.8 b/nixos/doc/manual/manpages/nixos-version.8 index 980ee8b1f49e953..f661611599fb0f9 100644 --- a/nixos/doc/manual/manpages/nixos-version.8 +++ b/nixos/doc/manual/manpages/nixos-version.8 @@ -1,10 +1,6 @@ .Dd January 1, 1980 -.\" nixpkgs groff will use Nixpkgs as the OS in the title by default, taking it from -.\" doc-default-operating-system. mandoc doesn't have this register set by default, -.\" so we can use it as a groff/mandoc switch. -.ie ddoc-default-operating-system .Dt nixos-version \&8 "NixOS System Manager's Manual" -.el .Dt nixos-version 8 -.Os NixOS +.Dt nixos-version 8 +.Os .Sh NAME .Nm nixos-version .Nd show the NixOS version