lol

nixos: fix backticks in Markdown descriptions

authored by

Naïm Favier and committed by
pennae
36315860 5305f766

+17 -17
+1 -1
nixos/modules/config/mysql.nix
··· 181 181 example = "pid"; 182 182 description = lib.mdDoc '' 183 183 The name of the column in the log table to which the pid of the 184 - process utilising the `pam_mysql's` authentication 184 + process utilising the `pam_mysql` authentication 185 185 service is stored. 186 186 ''; 187 187 };
+1 -1
nixos/modules/security/acme/default.nix
··· 727 727 Default values inheritable by all configured certs. You can 728 728 use this to define options shared by all your certs. These defaults 729 729 can also be ignored on a per-cert basis using the 730 - `security.acme.certs.''${cert}.inheritDefaults' option. 730 + {option}`security.acme.certs.''${cert}.inheritDefaults` option. 731 731 ''; 732 732 }; 733 733
+1 -1
nixos/modules/security/audit.nix
··· 57 57 type = types.enum [ false true "lock" ]; 58 58 default = false; 59 59 description = lib.mdDoc '' 60 - Whether to enable the Linux audit system. The special `lock' value can be used to 60 + Whether to enable the Linux audit system. The special `lock` value can be used to 61 61 enable auditing and prevent disabling it until a restart. Be careful about locking 62 62 this, as it will prevent you from changing your audit configuration until you 63 63 restart. If possible, test your configuration using build-vm beforehand.
+1 -1
nixos/modules/services/audio/mpd.nix
··· 102 102 Extra directives added to to the end of MPD's configuration file, 103 103 mpd.conf. Basic configuration like file location and uid/gid 104 104 is added automatically to the beginning of the file. For available 105 - options see `man 5 mpd.conf`'. 105 + options see {manpage}`mpd.conf(5)`. 106 106 ''; 107 107 }; 108 108
+1 -1
nixos/modules/services/misc/gpsd.nix
··· 22 22 type = types.bool; 23 23 default = false; 24 24 description = lib.mdDoc '' 25 - Whether to enable `gpsd', a GPS service daemon. 25 + Whether to enable `gpsd`, a GPS service daemon. 26 26 ''; 27 27 }; 28 28
+1 -1
nixos/modules/services/misc/weechat.nix
··· 15 15 default = "/var/lib/weechat"; 16 16 }; 17 17 sessionName = mkOption { 18 - description = lib.mdDoc "Name of the `screen' session for weechat."; 18 + description = lib.mdDoc "Name of the `screen` session for weechat."; 19 19 default = "weechat-screen"; 20 20 type = types.str; 21 21 };
+2 -2
nixos/modules/services/networking/avahi-daemon.nix
··· 47 47 Whether to run the Avahi daemon, which allows Avahi clients 48 48 to use Avahi's service discovery facilities and also allows 49 49 the local machine to advertise its presence and services 50 - (through the mDNS responder implemented by `avahi-daemon'). 50 + (through the mDNS responder implemented by `avahi-daemon`). 51 51 ''; 52 52 }; 53 53 ··· 205 205 default = false; 206 206 description = lib.mdDoc '' 207 207 Whether to enable the mDNS NSS (Name Service Switch) plug-in. 208 - Enabling it allows applications to resolve names in the `.local' 208 + Enabling it allows applications to resolve names in the `.local` 209 209 domain by transparently querying the Avahi daemon. 210 210 ''; 211 211 };
+2 -2
nixos/modules/services/networking/gnunet.nix
··· 124 124 type = types.lines; 125 125 default = ""; 126 126 description = lib.mdDoc '' 127 - Additional options that will be copied verbatim in `gnunet.conf'. 128 - See `gnunet.conf(5)' for details. 127 + Additional options that will be copied verbatim in `gnunet.conf`. 128 + See {manpage}`gnunet.conf(5)` for details. 129 129 ''; 130 130 }; 131 131 };
+1 -1
nixos/modules/services/networking/nat.nix
··· 124 124 type = types.listOf types.str; 125 125 default = [ ]; 126 126 example = literalExpression ''[ "55.1.2.3" ]''; 127 - description = lib.mdDoc "Public IPs for NAT reflection; for connections to `loopbackip:sourcePort' from the host itself and from other hosts behind NAT"; 127 + description = lib.mdDoc "Public IPs for NAT reflection; for connections to `loopbackip:sourcePort` from the host itself and from other hosts behind NAT"; 128 128 }; 129 129 }; 130 130 });
+1 -1
nixos/modules/services/networking/rpcbind.nix
··· 14 14 type = types.bool; 15 15 default = false; 16 16 description = lib.mdDoc '' 17 - Whether to enable `rpcbind', an ONC RPC directory service 17 + Whether to enable `rpcbind`, an ONC RPC directory service 18 18 notably used by NFS and NIS, and which can be queried 19 19 using the rpcinfo(1) command. `rpcbind` is a replacement for 20 20 `portmap`.
+1 -1
nixos/modules/services/networking/ssh/lshd.nix
··· 40 40 type = types.listOf types.str; 41 41 description = lib.mdDoc '' 42 42 List of network interfaces where listening for connections. 43 - When providing the empty list, `[]', lshd listens on all 43 + When providing the empty list, `[]`, lshd listens on all 44 44 network interfaces. 45 45 ''; 46 46 example = [ "localhost" "1.2.3.4:443" ];
+4 -4
nixos/modules/services/web-apps/hedgedoc.nix
··· 950 950 type = types.str; 951 951 default = ""; 952 952 description = lib.mdDoc '' 953 - Attribute map for `id'. 954 - Defaults to `NameID' of SAML response. 953 + Attribute map for `id`. 954 + Defaults to `NameID` of SAML response. 955 955 ''; 956 956 }; 957 957 username = mkOption { 958 958 type = types.str; 959 959 default = ""; 960 960 description = lib.mdDoc '' 961 - Attribute map for `username'. 962 - Defaults to `NameID' of SAML response. 961 + Attribute map for `username`. 962 + Defaults to `NameID` of SAML response. 963 963 ''; 964 964 }; 965 965 email = mkOption {