diff options
author | pennae <github@quasiparticle.net> | 2022-08-03 22:46:41 +0200 |
---|---|---|
committer | pennae <github@quasiparticle.net> | 2022-08-03 22:46:41 +0200 |
commit | 61e93df1891972bae3e0c97a477bd44e8a477aa0 (patch) | |
tree | 4285c1d22db537fb02baf1e978eb4434b0276b0c /nixos/modules/programs | |
parent | 645cfa59ac5690187eac40ef2ac67381668acecc (diff) |
nixos/*: automatically convert option docs to MD
once again using nix-doc-munge (https://github.com/pennae/nix-doc-munge/commit/69d080323ae27c0d8da3967c62b925a9aedb2828)
Diffstat (limited to 'nixos/modules/programs')
-rw-r--r-- | nixos/modules/programs/adb.nix | 4 | ||||
-rw-r--r-- | nixos/modules/programs/firejail.nix | 4 | ||||
-rw-r--r-- | nixos/modules/programs/gphoto2.nix | 4 | ||||
-rw-r--r-- | nixos/modules/programs/neovim.nix | 4 | ||||
-rw-r--r-- | nixos/modules/programs/nncp.nix | 18 | ||||
-rw-r--r-- | nixos/modules/programs/turbovnc.nix | 6 |
6 files changed, 20 insertions, 20 deletions
diff --git a/nixos/modules/programs/adb.nix b/nixos/modules/programs/adb.nix index 6340319392075..e5b0abd9fcfed 100644 --- a/nixos/modules/programs/adb.nix +++ b/nixos/modules/programs/adb.nix @@ -11,10 +11,10 @@ with lib; enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to configure system to use Android Debug Bridge (adb). To grant access to a user, it must be part of adbusers group: - <literal>users.users.alice.extraGroups = ["adbusers"];</literal> + `users.users.alice.extraGroups = ["adbusers"];` ''; }; }; diff --git a/nixos/modules/programs/firejail.nix b/nixos/modules/programs/firejail.nix index b9a0f9a691130..417eff91d3c7c 100644 --- a/nixos/modules/programs/firejail.nix +++ b/nixos/modules/programs/firejail.nix @@ -69,12 +69,12 @@ in { }; } ''; - description = '' + description = lib.mdDoc '' Wrap the binaries in firejail and place them in the global path. You will get file collisions if you put the actual application binary in the global environment (such as by adding the application package to - <literal>environment.systemPackages</literal>), and applications started via + `environment.systemPackages`), and applications started via .desktop files are not wrapped if they specify the absolute path to the binary. ''; diff --git a/nixos/modules/programs/gphoto2.nix b/nixos/modules/programs/gphoto2.nix index 373b53495f752..f31b1863963d9 100644 --- a/nixos/modules/programs/gphoto2.nix +++ b/nixos/modules/programs/gphoto2.nix @@ -11,11 +11,11 @@ with lib; enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to configure system to use gphoto2. To grant digital camera access to a user, the user must be part of the camera group: - <literal>users.users.alice.extraGroups = ["camera"];</literal> + `users.users.alice.extraGroups = ["camera"];` ''; }; }; diff --git a/nixos/modules/programs/neovim.nix b/nixos/modules/programs/neovim.nix index 2c39456895f3f..85963159a7250 100644 --- a/nixos/modules/programs/neovim.nix +++ b/nixos/modules/programs/neovim.nix @@ -72,9 +72,9 @@ in { }; } ''; - description = '' + description = lib.mdDoc '' Generate your init file from your list of plugins and custom commands. - Neovim will then be wrapped to load <command>nvim -u /nix/store/«hash»-vimrc</command> + Neovim will then be wrapped to load {command}`nvim -u /nix/store/«hash»-vimrc` ''; }; diff --git a/nixos/modules/programs/nncp.nix b/nixos/modules/programs/nncp.nix index f40e888dad8c0..a58748d2fe62b 100644 --- a/nixos/modules/programs/nncp.nix +++ b/nixos/modules/programs/nncp.nix @@ -33,24 +33,24 @@ in { secrets = mkOption { type = with types; listOf str; example = [ "/run/keys/nncp.hjson" ]; - description = '' + description = lib.mdDoc '' A list of paths to NNCP configuration files that should not be in the Nix store. These files are layered on top of the values at - <xref linkend="opt-programs.nncp.settings"/>. + [](#opt-programs.nncp.settings). ''; }; settings = mkOption { type = settingsFormat.type; - description = '' + description = lib.mdDoc '' NNCP configuration, see - <link xlink:href="http://www.nncpgo.org/Configuration.html"/>. + <http://www.nncpgo.org/Configuration.html>. At runtime these settings will be overlayed by the contents of - <xref linkend="opt-programs.nncp.secrets"/> into the file - <literal>${nncpCfgFile}</literal>. Node keypairs go in - <literal>secrets</literal>, do not specify them in - <literal>settings</literal> as they will be leaked into - <literal>/nix/store</literal>! + [](#opt-programs.nncp.secrets) into the file + `${nncpCfgFile}`. Node keypairs go in + `secrets`, do not specify them in + `settings` as they will be leaked into + `/nix/store`! ''; default = { }; }; diff --git a/nixos/modules/programs/turbovnc.nix b/nixos/modules/programs/turbovnc.nix index eb09c554290fe..a0e4a36cfd995 100644 --- a/nixos/modules/programs/turbovnc.nix +++ b/nixos/modules/programs/turbovnc.nix @@ -15,14 +15,14 @@ in ensureHeadlessSoftwareOpenGL = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to set up NixOS such that TurboVNC's built-in software OpenGL implementation works. - This will enable <option>hardware.opengl.enable</option> so that OpenGL + This will enable {option}`hardware.opengl.enable` so that OpenGL programs can find Mesa's llvmpipe drivers. - Setting this option to <literal>false</literal> does not mean that software + Setting this option to `false` does not mean that software OpenGL won't work; it may still work depending on your system configuration. |