nixos/*: convert options with admonitions to MD

rendering changes only slightly, most changes are in spacing.
This commit is contained in:
pennae 2022-08-30 02:30:04 +02:00
parent bd56368848
commit 722b99bc0e
50 changed files with 568 additions and 568 deletions

View file

@ -484,14 +484,14 @@ in
user = mkOption {
type = types.str;
default = "wwwrun";
description = ''
description = lib.mdDoc ''
User account under which httpd children processes run.
If you require the main httpd process to run as
<literal>root</literal> add the following configuration:
<programlisting>
`root` add the following configuration:
```
systemd.services.httpd.serviceConfig.User = lib.mkForce "root";
</programlisting>
```
'';
};

View file

@ -45,16 +45,14 @@ in
{ ip = "192.154.1.1"; port = 80; }
{ ip = "*"; port = 8080; }
];
description = ''
description = lib.mdDoc ''
Listen addresses and ports for this virtual host.
<note>
<para>
This option overrides <literal>addSSL</literal>, <literal>forceSSL</literal> and <literal>onlySSL</literal>.
</para>
<para>
If you only want to set the addresses manually and not the ports, take a look at <literal>listenAddresses</literal>.
</para>
</note>
::: {.note}
This option overrides `addSSL`, `forceSSL` and `onlySSL`.
If you only want to set the addresses manually and not the ports, take a look at `listenAddresses`.
:::
'';
};
@ -202,14 +200,14 @@ in
file = "/home/eelco/some-file.png";
}
];
description = ''
description = lib.mdDoc ''
This option provides a simple way to serve individual, static files.
<note><para>
This option has been deprecated and will be removed in a future
version of NixOS. You can achieve the same result by making use of
the <literal>locations.&lt;name&gt;.alias</literal> option.
</para></note>
::: {.note}
This option has been deprecated and will be removed in a future
version of NixOS. You can achieve the same result by making use of
the `locations.<name>.alias` option.
:::
'';
};