nordic-dev.net/nixpkgs
nordic-dev.net/nixpkgs
2
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2024-11-01 07:01:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

nixos/*: convert some markdown in docbook to tags

Browse Source 
a lot of markdown syntax has already snuck into option docs, many of it
predating the intent to migrate to markdown. we don't convert all of it
here, just that which is accompanied by docbook tags as well. the rest
can be converted by simply adding the mdDoc marker.
This commit is contained in:
pennae 2022-08-13 11:56:56 +02:00 committed by pennae
parent b0e56acef9
commit 72b507d5a2
8 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
nixos/modules/services/games/asf.nix
View File

@ -83,8 +83,8 @@ in
type = format.type;
description = ''
The ASF.json file, all the options are documented <link xlink:href="https://github.com/JustArchiNET/ArchiSteamFarm/wiki/Configuration#global-config">here</link>.
Do note that `AutoRestart` and `UpdateChannel` is always to `false` respectively `0` because NixOS takes care of updating everything.
`Headless` is also always set to `true` because there is no way to provide inputs via a systemd service.
Do note that <literal>AutoRestart</literal> and <literal>UpdateChannel</literal> is always to <literal>false</literal> respectively <literal>0</literal> because NixOS takes care of updating everything.
<literal>Headless</literal> is also always set to <literal>true</literal> because there is no way to provide inputs via a systemd service.
You should try to keep ASF up to date since upstream does not provide support for anything but the latest version and you're exposing yourself to all kinds of issues - as is outlined <link xlink:href="https://github.com/JustArchiNET/ArchiSteamFarm/wiki/Configuration#updateperiod">here</link>.
'';
example = {

2
nixos/modules/services/misc/gitolite.nix
View File

@ -83,7 +83,7 @@ in
If you already have a customized (or otherwise changed)
<literal>~/.gitolite.rc</literal> file, NixOS will refuse to replace
it with a symlink, and the `gitolite-init` initialization service
it with a symlink, and the <literal>gitolite-init</literal> initialization service
will fail. In this situation, in order to use this option, you
will need to take any customizations you may have in
<literal>~/.gitolite.rc</literal>, convert them to appropriate Perl

4
nixos/modules/services/networking/nix-serve.nix
View File

@ -39,9 +39,9 @@ in
The path to the file used for signing derivation data.
Generate with:
```
<programlisting>
nix-store --generate-binary-cache-key key-name secret-key-file public-key-file
```
</programlisting>
For more details see <citerefentry><refentrytitle>nix-store</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
'';

2
nixos/modules/services/networking/v2ray.nix
View File

@ -54,7 +54,7 @@ with lib;
description = ''
The configuration object.
Either `configFile` or `config` must be specified.
Either <literal>configFile</literal> or <literal>config</literal> must be specified.
See <link xlink:href="https://www.v2fly.org/en_US/config/overview.html"/>.
'';

2
nixos/modules/services/networking/znc/options.nix
View File

@ -178,7 +178,7 @@ in
'';
type = types.str;
description = ''
Generate with `nix-shell -p znc --command "znc --makepass"`.
Generate with <command>nix-shell -p znc --command "znc --makepass"</command>.
This is the password used to log in to the ZNC web admin interface.
You can also set this through
<option>services.znc.config.User.&lt;username&gt;.Pass.Method</option>

6
nixos/modules/services/web-apps/hedgedoc.nix
View File

@ -190,7 +190,7 @@ in
type = types.bool;
default = false;
description = ''
Whether to allow guests to edit existing notes with the `freely' permission,
Whether to allow guests to edit existing notes with the <literal>freely</literal> permission,
when <option>allowAnonymous</option> is enabled.
'';
};
@ -954,8 +954,8 @@ in
type = types.str;
default = "";
description = ''
Attribute map for `email'.
Defaults to `NameID' of SAML response if
Attribute map for <literal>email</literal>.
Defaults to <literal>NameID</literal> of SAML response if
<option>identifierFormat</option> has
the default value.
'';

2
nixos/modules/services/web-apps/matomo.nix
View File

@ -57,7 +57,7 @@ in {
Name of the web server user that forwards requests to <option>services.phpfpm.pools.&lt;name&gt;.socket</option> the fastcgi socket for Matomo if the nginx
option is not used. Either this option or the nginx option is mandatory.
If you want to use another webserver than nginx, you need to set this to that server's user
and pass fastcgi requests to `index.php`, `matomo.php` and `piwik.php` (legacy name) to this socket.
and pass fastcgi requests to <literal>index.php</literal>, <literal>matomo.php</literal> and <literal>piwik.php</literal> (legacy name) to this socket.
'';
};

2
nixos/modules/services/web-servers/nginx/vhost-options.nix
View File

@ -202,7 +202,7 @@ with lib;
This requires using <literal>pkgs.nginxQuic</literal> package
which can be achieved by setting <literal>services.nginx.package = pkgs.nginxQuic;</literal>.
Note that HTTP 3 support is experimental and
*not* yet recommended for production.
<emphasis>not</emphasis> yet recommended for production.
Read more at https://quic.nginx.org/
'';
};