diff options
author | pennae <github@quasiparticle.net> | 2022-08-13 11:56:56 +0200 |
---|---|---|
committer | pennae <82953136+pennae@users.noreply.github.com> | 2022-08-19 22:40:58 +0200 |
commit | 72b507d5a20d9eec76addd4b812dbf11b95264a9 (patch) | |
tree | b06e7c83777bc0877da6fb591bf6e91d5de5774e | |
parent | b0e56acef90e1726c588aac13fe7e5fae0ed1a95 (diff) | |
download | nixpkgs-72b507d5a20d9eec76addd4b812dbf11b95264a9.tar nixpkgs-72b507d5a20d9eec76addd4b812dbf11b95264a9.tar.gz nixpkgs-72b507d5a20d9eec76addd4b812dbf11b95264a9.tar.bz2 nixpkgs-72b507d5a20d9eec76addd4b812dbf11b95264a9.tar.lz nixpkgs-72b507d5a20d9eec76addd4b812dbf11b95264a9.tar.xz nixpkgs-72b507d5a20d9eec76addd4b812dbf11b95264a9.tar.zst nixpkgs-72b507d5a20d9eec76addd4b812dbf11b95264a9.zip |
nixos/*: convert some markdown in docbook to tags
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.
-rw-r--r-- | nixos/modules/services/games/asf.nix | 4 | ||||
-rw-r--r-- | nixos/modules/services/misc/gitolite.nix | 2 | ||||
-rw-r--r-- | nixos/modules/services/networking/nix-serve.nix | 4 | ||||
-rw-r--r-- | nixos/modules/services/networking/v2ray.nix | 2 | ||||
-rw-r--r-- | nixos/modules/services/networking/znc/options.nix | 2 | ||||
-rw-r--r-- | nixos/modules/services/web-apps/hedgedoc.nix | 6 | ||||
-rw-r--r-- | nixos/modules/services/web-apps/matomo.nix | 2 | ||||
-rw-r--r-- | nixos/modules/services/web-servers/nginx/vhost-options.nix | 2 |
8 files changed, 12 insertions, 12 deletions
diff --git a/nixos/modules/services/games/asf.nix b/nixos/modules/services/games/asf.nix index b7892900376..129a2849102 100644 --- a/nixos/modules/services/games/asf.nix +++ b/nixos/modules/services/games/asf.nix @@ -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 = { diff --git a/nixos/modules/services/misc/gitolite.nix b/nixos/modules/services/misc/gitolite.nix index 7de0e4f4897..0a1ca262e6e 100644 --- a/nixos/modules/services/misc/gitolite.nix +++ b/nixos/modules/services/misc/gitolite.nix @@ -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 diff --git a/nixos/modules/services/networking/nix-serve.nix b/nixos/modules/services/networking/nix-serve.nix index 04cbc0c0d8f..5deb31a486b 100644 --- a/nixos/modules/services/networking/nix-serve.nix +++ b/nixos/modules/services/networking/nix-serve.nix @@ -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>. ''; diff --git a/nixos/modules/services/networking/v2ray.nix b/nixos/modules/services/networking/v2ray.nix index f063ddfed0a..df4b41eecbd 100644 --- a/nixos/modules/services/networking/v2ray.nix +++ b/nixos/modules/services/networking/v2ray.nix @@ -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"/>. ''; diff --git a/nixos/modules/services/networking/znc/options.nix b/nixos/modules/services/networking/znc/options.nix index 021fea9819a..0b86c34678d 100644 --- a/nixos/modules/services/networking/znc/options.nix +++ b/nixos/modules/services/networking/znc/options.nix @@ -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.<username>.Pass.Method</option> diff --git a/nixos/modules/services/web-apps/hedgedoc.nix b/nixos/modules/services/web-apps/hedgedoc.nix index 348192ea848..691e0dec3bc 100644 --- a/nixos/modules/services/web-apps/hedgedoc.nix +++ b/nixos/modules/services/web-apps/hedgedoc.nix @@ -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. ''; diff --git a/nixos/modules/services/web-apps/matomo.nix b/nixos/modules/services/web-apps/matomo.nix index 80c4db1263e..f9927992a86 100644 --- a/nixos/modules/services/web-apps/matomo.nix +++ b/nixos/modules/services/web-apps/matomo.nix @@ -57,7 +57,7 @@ in { Name of the web server user that forwards requests to <option>services.phpfpm.pools.<name>.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. ''; }; diff --git a/nixos/modules/services/web-servers/nginx/vhost-options.nix b/nixos/modules/services/web-servers/nginx/vhost-options.nix index a749f8bc20f..d8d43bbdade 100644 --- a/nixos/modules/services/web-servers/nginx/vhost-options.nix +++ b/nixos/modules/services/web-servers/nginx/vhost-options.nix @@ -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/ ''; }; |