Skip to content

Commit 9ab61b2

Browse files
authored
nixos/doc: convert links to manpages (#383975)
2 parents 7bdc9b7 + 527be14 commit 9ab61b2

File tree

11 files changed

+17
-23
lines changed

11 files changed

+17
-23
lines changed

nixos/modules/image/repart.nix

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ let
5656
};
5757
description = ''
5858
Specify the repart options for a partiton as a structural setting.
59-
See <https://www.freedesktop.org/software/systemd/man/repart.d.html>
59+
See {manpage}`repart.d(5)`
6060
for all available options.
6161
'';
6262
};

nixos/modules/misc/version.nix

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -189,9 +189,9 @@ in
189189
description = ''
190190
Image identifier.
191191
192-
This corresponds to the IMAGE_ID field in os-release. See the
192+
This corresponds to the `IMAGE_ID` field in {manpage}`os-release(5)`. See the
193193
upstream docs for more details on valid characters for this field:
194-
https://www.freedesktop.org/software/systemd/man/latest/os-release.html#IMAGE_ID=
194+
<https://www.freedesktop.org/software/systemd/man/latest/os-release.html#IMAGE_ID=>
195195
196196
You would only want to set this option if you're build NixOS appliance images.
197197
'';
@@ -203,9 +203,9 @@ in
203203
description = ''
204204
Image version.
205205
206-
This corresponds to the IMAGE_VERSION field in os-release. See the
206+
This corresponds to the `IMAGE_VERSION` field in {manpage}`os-release(5)`. See the
207207
upstream docs for more details on valid characters for this field:
208-
https://www.freedesktop.org/software/systemd/man/latest/os-release.html#IMAGE_VERSION=
208+
<https://www.freedesktop.org/software/systemd/man/latest/os-release.html#IMAGE_VERSION=>
209209
210210
You would only want to set this option if you're build NixOS appliance images.
211211
'';

nixos/modules/services/games/mchprs.nix

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ in
7777
description = ''
7878
Automatically restart the server after
7979
{option}`services.mchprs.maxRuntime`.
80-
The time span format is described here:
80+
The {manpage}`systemd.time(7)` time span format is described here:
8181
<https://www.freedesktop.org/software/systemd/man/systemd.time.html#Parsing%20Time%20Spans>.
8282
If `null`, then the server is not restarted automatically.
8383
'';

nixos/modules/services/networking/networkd-dispatcher.nix

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ in
6464
default = null;
6565
description = ''
6666
List of names of the systemd-networkd operational states which
67-
should trigger the script. See <https://www.freedesktop.org/software/systemd/man/networkctl.html>
67+
should trigger the script. See {manpage}`networkctl(1)`
6868
for a description of the specific state type.
6969
'';
7070
};

nixos/modules/services/web-servers/static-web-server.nix

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ in
1818
default = "[::]:8787";
1919
type = lib.types.str;
2020
description = ''
21-
The "ListenStream" used in static-web-server.socket.
21+
The {manpage}`systemd.socket(5)` "ListenStream" used in static-web-server.socket.
2222
This is equivalent to SWS's "host" and "port" options.
2323
See here for specific syntax: <https://www.freedesktop.org/software/systemd/man/systemd.socket.html#ListenStream=>
2424
'';

nixos/modules/system/boot/systemd/journald.nix

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,7 @@ in
6464
6565
Note that the effective rate limit is multiplied by a factor derived
6666
from the available free disk space for the journal as described on
67-
[
68-
journald.conf(5)](https://www.freedesktop.org/software/systemd/man/journald.conf.html).
67+
{manpage}`journald.conf(5)`.
6968
7069
Note that the total amount of logs stored is limited by journald settings
7170
such as `SystemMaxUse`, which defaults to 10% the file system size

nixos/modules/system/boot/systemd/logind.nix

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@ in
4242
when the user logs out. If true, the scope unit corresponding
4343
to the session and all processes inside that scope will be
4444
terminated. If false, the scope is "abandoned"
45-
(see [systemd.scope(5)](https://www.freedesktop.org/software/systemd/man/systemd.scope.html#)),
45+
(see {manpage}`systemd.scope(5)`),
4646
and processes are not killed.
4747
48-
See [logind.conf(5)](https://www.freedesktop.org/software/systemd/man/logind.conf.html#KillUserProcesses=)
48+
See {manpage}`logind.conf(5)`
4949
for more details.
5050
'';
5151
};

nixos/modules/system/boot/systemd/repart.nix

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,8 +109,7 @@ in
109109
description = ''
110110
Specify partitions as a set of the names of the definition files as the
111111
key and the partition configuration as its value. The partition
112-
configuration can use all upstream options. See <link
113-
xlink:href="https://www.freedesktop.org/software/systemd/man/repart.d.html"/>
112+
configuration can use all upstream options. See {manpage}`repart.d(5)`
114113
for all available options.
115114
'';
116115
};

nixos/modules/system/boot/systemd/sysupdate.nix

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,7 @@ in
2424
If enabled, updates are triggered in regular intervals via a
2525
`systemd.timer` unit.
2626
27-
Please see
28-
<https://www.freedesktop.org/software/systemd/man/systemd-sysupdate.html>
29-
for more details.
27+
Please see {manpage}`systemd-sysupdate(8)` for more details.
3028
'';
3129
};
3230

@@ -108,8 +106,7 @@ in
108106
description = ''
109107
Specify transfers as a set of the names of the transfer files as the
110108
key and the configuration as its value. The configuration can use all
111-
upstream options. See
112-
<https://www.freedesktop.org/software/systemd/man/sysupdate.d.html>
109+
upstream options. See {manpage}`sysupdate.d(5)`
113110
for all available options.
114111
'';
115112
};

nixos/modules/system/boot/systemd/tmpfiles.nix

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ let
4343
4444
Please see the upstream documentation for the available types and
4545
more details:
46-
<https://www.freedesktop.org/software/systemd/man/tmpfiles.d>
46+
{manpage}`tmpfiles.d(5)`
4747
'';
4848
};
4949
options.mode = mkOption {
@@ -102,7 +102,7 @@ let
102102
103103
Please see the upstream documentation for the meaning of this
104104
parameter in different situations:
105-
<https://www.freedesktop.org/software/systemd/man/tmpfiles.d>
105+
{manpage}`tmpfiles.d(5)`
106106
'';
107107
};
108108
}))));

0 commit comments

Comments
 (0)