movefasta/nixpkgs
1
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-06-09 19:13:26 +03:00
Code Issues Projects Releases Packages Wiki Activity

nixos/doc: convert links to manpages

Browse source
This commit is contained in:
Peder Bergebakken Sundt 2025-02-21 16:31:09 +01:00
parent 4eb4da2437
commit 527be14321
11 changed files with 17 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

2
nixos/modules/image/repart.nix
View file

@ -56,7 +56,7 @@ let
};
description = ''
Specify the repart options for a partiton as a structural setting.
See <https://www.freedesktop.org/software/systemd/man/repart.d.html>
See {manpage}`repart.d(5)`
for all available options.
'';
};

8
nixos/modules/misc/version.nix
View file

@ -189,9 +189,9 @@ in
description = ''
Image identifier.
This corresponds to the IMAGE_ID field in os-release. See the
This corresponds to the `IMAGE_ID` field in {manpage}`os-release(5)`. See the
upstream docs for more details on valid characters for this field:
https://www.freedesktop.org/software/systemd/man/latest/os-release.html#IMAGE_ID=
<https://www.freedesktop.org/software/systemd/man/latest/os-release.html#IMAGE_ID=>
You would only want to set this option if you're build NixOS appliance images.
'';
@ -203,9 +203,9 @@ in
description = ''
Image version.
This corresponds to the IMAGE_VERSION field in os-release. See the
This corresponds to the `IMAGE_VERSION` field in {manpage}`os-release(5)`. See the
upstream docs for more details on valid characters for this field:
https://www.freedesktop.org/software/systemd/man/latest/os-release.html#IMAGE_VERSION=
<https://www.freedesktop.org/software/systemd/man/latest/os-release.html#IMAGE_VERSION=>
You would only want to set this option if you're build NixOS appliance images.
'';

2
nixos/modules/services/games/mchprs.nix
View file

@ -77,7 +77,7 @@ in
description = ''
Automatically restart the server after
{option}`services.mchprs.maxRuntime`.
The time span format is described here:
The {manpage}`systemd.time(7)` time span format is described here:
<https://www.freedesktop.org/software/systemd/man/systemd.time.html#Parsing%20Time%20Spans>.
If `null`, then the server is not restarted automatically.
'';

2
nixos/modules/services/networking/networkd-dispatcher.nix
View file

@ -63,7 +63,7 @@ in
default = null;
description = ''
List of names of the systemd-networkd operational states which
should trigger the script. See <https://www.freedesktop.org/software/systemd/man/networkctl.html>
should trigger the script. See {manpage}`networkctl(1)`
for a description of the specific state type.
'';
};

2
nixos/modules/services/web-servers/static-web-server.nix
View file

@ -18,7 +18,7 @@ in
default = "[::]:8787";
type = lib.types.str;
description = ''
The "ListenStream" used in static-web-server.socket.
The {manpage}`systemd.socket(5)` "ListenStream" used in static-web-server.socket.
This is equivalent to SWS's "host" and "port" options.
See here for specific syntax: <https://www.freedesktop.org/software/systemd/man/systemd.socket.html#ListenStream=>
'';

3
nixos/modules/system/boot/systemd/journald.nix
View file

@ -64,8 +64,7 @@ in
Note that the effective rate limit is multiplied by a factor derived
from the available free disk space for the journal as described on
[
journald.conf(5)](https://www.freedesktop.org/software/systemd/man/journald.conf.html).
{manpage}`journald.conf(5)`.
Note that the total amount of logs stored is limited by journald settings
such as `SystemMaxUse`, which defaults to 10% the file system size

4
nixos/modules/system/boot/systemd/logind.nix
View file

@ -42,10 +42,10 @@ in
when the user logs out. If true, the scope unit corresponding
to the session and all processes inside that scope will be
terminated. If false, the scope is "abandoned"
(see [systemd.scope(5)](https://www.freedesktop.org/software/systemd/man/systemd.scope.html#)),
(see {manpage}`systemd.scope(5)`),
and processes are not killed.
See [logind.conf(5)](https://www.freedesktop.org/software/systemd/man/logind.conf.html#KillUserProcesses=)
See {manpage}`logind.conf(5)`
for more details.
'';
};

3
nixos/modules/system/boot/systemd/repart.nix
View file

@ -109,8 +109,7 @@ in
description = ''
Specify partitions as a set of the names of the definition files as the
key and the partition configuration as its value. The partition
configuration can use all upstream options. See <link
xlink:href="https://www.freedesktop.org/software/systemd/man/repart.d.html"/>
configuration can use all upstream options. See {manpage}`repart.d(5)`
for all available options.
'';
};

7
nixos/modules/system/boot/systemd/sysupdate.nix
View file

@ -24,9 +24,7 @@ in
If enabled, updates are triggered in regular intervals via a
`systemd.timer` unit.
Please see
<https://www.freedesktop.org/software/systemd/man/systemd-sysupdate.html>
for more details.
Please see {manpage}`systemd-sysupdate(8)` for more details.
'';
};
@ -108,8 +106,7 @@ in
description = ''
Specify transfers as a set of the names of the transfer files as the
key and the configuration as its value. The configuration can use all
upstream options. See
<https://www.freedesktop.org/software/systemd/man/sysupdate.d.html>
upstream options. See {manpage}`sysupdate.d(5)`
for all available options.
'';
};

4
nixos/modules/system/boot/systemd/tmpfiles.nix
View file

@ -43,7 +43,7 @@ let
Please see the upstream documentation for the available types and
more details:
<https://www.freedesktop.org/software/systemd/man/tmpfiles.d>
{manpage}`tmpfiles.d(5)`
'';
};
options.mode = mkOption {
@ -102,7 +102,7 @@ let
Please see the upstream documentation for the meaning of this
parameter in different situations:
<https://www.freedesktop.org/software/systemd/man/tmpfiles.d>
{manpage}`tmpfiles.d(5)`
'';
};
}))));

3
nixos/modules/system/boot/timesyncd.nix
View file

@ -53,8 +53,7 @@ in
'';
description = ''
Extra config options for systemd-timesyncd. See
[
timesyncd.conf(5)](https://www.freedesktop.org/software/systemd/man/timesyncd.conf.html) for available options.
{manpage}`timesyncd.conf(5)` for available options.
'';
};
};