From 72b507d5a20d9eec76addd4b812dbf11b95264a9 Mon Sep 17 00:00:00 2001 From: pennae Date: Sat, 13 Aug 2022 11:56:56 +0200 Subject: 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. --- nixos/modules/services/games/asf.nix | 4 ++-- nixos/modules/services/misc/gitolite.nix | 2 +- nixos/modules/services/networking/nix-serve.nix | 4 ++-- nixos/modules/services/networking/v2ray.nix | 2 +- nixos/modules/services/networking/znc/options.nix | 2 +- nixos/modules/services/web-apps/hedgedoc.nix | 6 +++--- nixos/modules/services/web-apps/matomo.nix | 2 +- 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 b7892900376f..129a2849102f 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 here. - 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 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. 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 here. ''; example = { diff --git a/nixos/modules/services/misc/gitolite.nix b/nixos/modules/services/misc/gitolite.nix index 7de0e4f4897c..0a1ca262e6e3 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) ~/.gitolite.rc file, NixOS will refuse to replace - it with a symlink, and the `gitolite-init` initialization service + it with a symlink, and the gitolite-init initialization service will fail. In this situation, in order to use this option, you will need to take any customizations you may have in ~/.gitolite.rc, convert them to appropriate Perl diff --git a/nixos/modules/services/networking/nix-serve.nix b/nixos/modules/services/networking/nix-serve.nix index 04cbc0c0d8f8..5deb31a486b2 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: - ``` + nix-store --generate-binary-cache-key key-name secret-key-file public-key-file - ``` + For more details see nix-store1. ''; diff --git a/nixos/modules/services/networking/v2ray.nix b/nixos/modules/services/networking/v2ray.nix index f063ddfed0a7..df4b41eecbd4 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 configFile or config must be specified. See . ''; diff --git a/nixos/modules/services/networking/znc/options.nix b/nixos/modules/services/networking/znc/options.nix index 021fea9819a7..0b86c34678d1 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 nix-shell -p znc --command "znc --makepass". This is the password used to log in to the ZNC web admin interface. You can also set this through diff --git a/nixos/modules/services/web-apps/hedgedoc.nix b/nixos/modules/services/web-apps/hedgedoc.nix index 348192ea8486..691e0dec3bc2 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 freely permission, when 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 email. + Defaults to NameID of SAML response if has the default value. ''; diff --git a/nixos/modules/services/web-apps/matomo.nix b/nixos/modules/services/web-apps/matomo.nix index 80c4db1263e1..f9927992a865 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 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 index.php, matomo.php and piwik.php (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 a749f8bc20f1..d8d43bbdadef 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 pkgs.nginxQuic package which can be achieved by setting services.nginx.package = pkgs.nginxQuic;. Note that HTTP 3 support is experimental and - *not* yet recommended for production. + not yet recommended for production. Read more at https://quic.nginx.org/ ''; }; -- cgit 1.4.1