Skip to content

Commit

Permalink
nixos/doc: don't prescribe OS / manual name
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
sternenseemann committed Feb 23, 2023
1 parent 4f84f0c commit d1fa5dd
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 42 deletions.
8 changes: 2 additions & 6 deletions nixos/doc/manual/manpages/nixos-build-vms.8
Original file line number Diff line number Diff line change
@@ -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
Expand Down
8 changes: 2 additions & 6 deletions nixos/doc/manual/manpages/nixos-enter.8
Original file line number Diff line number Diff line change
@@ -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
Expand Down
8 changes: 2 additions & 6 deletions nixos/doc/manual/manpages/nixos-generate-config.8
Original file line number Diff line number Diff line change
@@ -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
Expand Down
8 changes: 2 additions & 6 deletions nixos/doc/manual/manpages/nixos-install.8
Original file line number Diff line number Diff line change
@@ -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
Expand Down
8 changes: 2 additions & 6 deletions nixos/doc/manual/manpages/nixos-option.8
Original file line number Diff line number Diff line change
@@ -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
Expand Down
8 changes: 2 additions & 6 deletions nixos/doc/manual/manpages/nixos-rebuild.8
Original file line number Diff line number Diff line change
@@ -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
Expand Down
8 changes: 2 additions & 6 deletions nixos/doc/manual/manpages/nixos-version.8
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit d1fa5dd

Please sign in to comment.