movefasta/nixpkgs
0
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-07-13 13:40:28 +03:00
Code Activity

Merge pull request #185056 from pennae/option-docs-md

Browse source 
nixos/*: more option docs conversions
This commit is contained in:
pennae 2022-08-05 17:36:49 +02:00 • committed by GitHub
commit 93c57a9884
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
149 changed files with 1008 additions and 1119 deletions
Download patch file Download diff file Expand all files Collapse all files

4
nixos/modules/programs/adb.nix
View file

@ -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"];`
'';
};
};

7
nixos/modules/programs/firejail.nix
View file

@ -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.
'';

4
nixos/modules/programs/gphoto2.nix
View file

@ -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"];`
'';
};
};

2
nixos/modules/programs/kdeconnect.nix
View file

@ -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 {

4
nixos/modules/programs/neovim.nix
View file

@ -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`
'';
};

18
nixos/modules/programs/nncp.nix
View file

@ -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 = { };
};

2
nixos/modules/programs/ssh.nix
View file

@ -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.
'';

2
nixos/modules/programs/sway.nix
View file

@ -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 {

6
nixos/modules/programs/turbovnc.nix
View file

@ -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.