diff options
author | pennae <82953136+pennae@users.noreply.github.com> | 2022-08-05 17:36:49 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-08-05 17:36:49 +0200 |
commit | 93c57a988470c1948976b1bb70abbd5855c5b810 (patch) | |
tree | 1b2bacec0165ff9a7c01bbb79a55603016c4c467 /nixos/modules/programs | |
parent | cec6bcfd67419f73cd5fc98650bdc9ec41270404 (diff) | |
parent | af98bacbe014021172b75e608187fa84937a99ce (diff) |
Merge pull request #185056 from pennae/option-docs-md
nixos/*: more option docs conversions
Diffstat (limited to 'nixos/modules/programs')
-rw-r--r-- | nixos/modules/programs/adb.nix | 4 | ||||
-rw-r--r-- | nixos/modules/programs/firejail.nix | 7 | ||||
-rw-r--r-- | nixos/modules/programs/gphoto2.nix | 4 | ||||
-rw-r--r-- | nixos/modules/programs/kdeconnect.nix | 2 | ||||
-rw-r--r-- | nixos/modules/programs/neovim.nix | 4 | ||||
-rw-r--r-- | nixos/modules/programs/nncp.nix | 18 | ||||
-rw-r--r-- | nixos/modules/programs/ssh.nix | 2 | ||||
-rw-r--r-- | nixos/modules/programs/sway.nix | 2 | ||||
-rw-r--r-- | nixos/modules/programs/turbovnc.nix | 6 |
9 files changed, 24 insertions, 25 deletions
diff --git a/nixos/modules/programs/adb.nix b/nixos/modules/programs/adb.nix index 9e9e37f92a87d..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: - <code>users.users.alice.extraGroups = ["adbusers"];</code> + `users.users.alice.extraGroups = ["adbusers"];` ''; }; }; diff --git a/nixos/modules/programs/firejail.nix b/nixos/modules/programs/firejail.nix index 76b42168c198a..417eff91d3c7c 100644 --- a/nixos/modules/programs/firejail.nix +++ b/nixos/modules/programs/firejail.nix @@ -69,13 +69,12 @@ in { }; } ''; - description = '' + description = lib.mdDoc '' Wrap the binaries in firejail and place them in the global path. - </para> - <para> + You will get file collisions if you put the actual application binary in the global environment (such as by adding the application package to - <code>environment.systemPackages</code>), 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 93923ff3133cb..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: - <code>users.users.alice.extraGroups = ["camera"];</code> + `users.users.alice.extraGroups = ["camera"];` ''; }; }; diff --git a/nixos/modules/programs/kdeconnect.nix b/nixos/modules/programs/kdeconnect.nix index aa4302404ad47..1f326c9e92190 100644 --- a/nixos/modules/programs/kdeconnect.nix +++ b/nixos/modules/programs/kdeconnect.nix @@ -8,7 +8,7 @@ with lib; Note that it will open the TCP and UDP port from 1714 to 1764 as they are needed for it to function properly. You can use the <option>package</option> to use - <code>gnomeExtensions.gsconnect</code> as an alternative + <literal>gnomeExtensions.gsconnect</literal> as an alternative implementation if you use Gnome. ''; package = mkOption { diff --git a/nixos/modules/programs/neovim.nix b/nixos/modules/programs/neovim.nix index b1dbcd1813099..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/<replaceable>hash</replaceable>-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/ssh.nix b/nixos/modules/programs/ssh.nix index e0da6ef3b3ad3..9c4a95ef22c62 100644 --- a/nixos/modules/programs/ssh.nix +++ b/nixos/modules/programs/ssh.nix @@ -95,7 +95,7 @@ in default = ""; description = '' Extra configuration text prepended to <filename>ssh_config</filename>. Other generated - options will be added after a <code>Host *</code> pattern. + options will be added after a <literal>Host *</literal> pattern. See <citerefentry><refentrytitle>ssh_config</refentrytitle><manvolnum>5</manvolnum></citerefentry> for help. ''; diff --git a/nixos/modules/programs/sway.nix b/nixos/modules/programs/sway.nix index decae1b4d2da2..af2b261d3c5f9 100644 --- a/nixos/modules/programs/sway.nix +++ b/nixos/modules/programs/sway.nix @@ -39,7 +39,7 @@ in { Sway, the i3-compatible tiling Wayland compositor. You can manually launch Sway by executing "exec sway" on a TTY. Copy /etc/sway/config to ~/.config/sway/config to modify the default configuration. See - <link xlink:href="https://github.com/swaywm/sway/wiki" /> and + <link xlink:href="https://github.com/swaywm/sway/wiki"/> and "man 5 sway" for more information''; wrapperFeatures = mkOption { diff --git a/nixos/modules/programs/turbovnc.nix b/nixos/modules/programs/turbovnc.nix index e6f8836aa367f..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 <code>false</code> 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. |