swendel/nixpkgs
1
0
Fork 0
mirror of https://github.com/SebastianWendel/nixpkgs.git synced 2024-09-20 04:19:00 +02:00
Code Issues Packages Projects Releases Wiki Activity

nixos/config: invariant option docs MD conversions

Browse source
This commit is contained in:
pennae 2022-07-19 15:05:45 +02:00
parent d2db10786f
commit 8a79dfd94a
10 changed files with 51 additions and 52 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
nixos/modules/config/appstream.nix
View file

@ -6,9 +6,9 @@ with lib;
appstream.enable = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Whether to install files to support the
<link xlink:href="https://www.freedesktop.org/software/appstream/docs/index.html">AppStream metadata specification</link>.
[AppStream metadata specification](https://www.freedesktop.org/software/appstream/docs/index.html).
'';
};
};

8
nixos/modules/config/fonts/fontdir.nix
View file

@ -30,9 +30,9 @@ in
enable = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Whether to create a directory with links to all fonts in
<filename>/run/current-system/sw/share/X11/fonts</filename>.
{file}`/run/current-system/sw/share/X11/fonts`.
'';
};
@ -40,9 +40,9 @@ in
type = types.bool;
default = config.programs.xwayland.enable;
defaultText = literalExpression "config.programs.xwayland.enable";
description = ''
description = lib.mdDoc ''
Whether to decompress fonts in
<filename>/run/current-system/sw/share/X11/fonts</filename>.
{file}`/run/current-system/sw/share/X11/fonts`.
'';
};

19
nixos/modules/config/locale.nix
View file

@ -22,9 +22,8 @@ in
default = null;
type = timezone;
example = "America/New_York";
description = ''
The time zone used when displaying times and dates. See <link
xlink:href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones"/>
description = lib.mdDoc ''
The time zone used when displaying times and dates. See <https://en.wikipedia.org/wiki/List_of_tz_database_time_zones>
for a comprehensive list of possible values for this setting.
If null, the timezone will default to UTC and can be set imperatively
@ -35,7 +34,7 @@ in
hardwareClockInLocalTime = mkOption {
default = false;
type = types.bool;
description = "If set, keep the hardware clock in local time instead of UTC.";
description = lib.mdDoc "If set, keep the hardware clock in local time instead of UTC.";
};
};
@ -44,18 +43,18 @@ in
latitude = mkOption {
type = types.float;
description = ''
description = lib.mdDoc ''
Your current latitude, between
<literal>-90.0</literal> and <literal>90.0</literal>. Must be provided
`-90.0` and `90.0`. Must be provided
along with longitude.
'';
};
longitude = mkOption {
type = types.float;
description = ''
description = lib.mdDoc ''
Your current longitude, between
between <literal>-180.0</literal> and <literal>180.0</literal>. Must be
between `-180.0` and `180.0`. Must be
provided along with latitude.
'';
};
@ -63,9 +62,9 @@ in
provider = mkOption {
type = types.enum [ "manual" "geoclue2" ];
default = "manual";
description = ''
description = lib.mdDoc ''
The location provider to use for determining your location. If set to
<literal>manual</literal> you must also provide latitude/longitude.
`manual` you must also provide latitude/longitude.
'';
};

24
nixos/modules/config/nsswitch.nix
View file

@ -13,10 +13,10 @@ with lib;
type = types.listOf types.path;
internal = true;
default = [];
description = ''
description = lib.mdDoc ''
Search path for NSS (Name Service Switch) modules. This allows
several DNS resolution methods to be specified via
<filename>/etc/nsswitch.conf</filename>.
{file}`/etc/nsswitch.conf`.
'';
apply = list:
{
@ -28,8 +28,8 @@ with lib;
system.nssDatabases = {
passwd = mkOption {
type = types.listOf types.str;
description = ''
List of passwd entries to configure in <filename>/etc/nsswitch.conf</filename>.
description = lib.mdDoc ''
List of passwd entries to configure in {file}`/etc/nsswitch.conf`.
Note that "files" is always prepended while "systemd" is appended if nscd is enabled.
@ -40,8 +40,8 @@ with lib;
group = mkOption {
type = types.listOf types.str;
description = ''
List of group entries to configure in <filename>/etc/nsswitch.conf</filename>.
description = lib.mdDoc ''
List of group entries to configure in {file}`/etc/nsswitch.conf`.
Note that "files" is always prepended while "systemd" is appended if nscd is enabled.
@ -52,8 +52,8 @@ with lib;
shadow = mkOption {
type = types.listOf types.str;
description = ''
List of shadow entries to configure in <filename>/etc/nsswitch.conf</filename>.
description = lib.mdDoc ''
List of shadow entries to configure in {file}`/etc/nsswitch.conf`.
Note that "files" is always prepended.
@ -64,8 +64,8 @@ with lib;
hosts = mkOption {
type = types.listOf types.str;
description = ''
List of hosts entries to configure in <filename>/etc/nsswitch.conf</filename>.
description = lib.mdDoc ''
List of hosts entries to configure in {file}`/etc/nsswitch.conf`.
Note that "files" is always prepended, and "dns" and "myhostname" are always appended.
@ -76,8 +76,8 @@ with lib;
services = mkOption {
type = types.listOf types.str;
description = ''
List of services entries to configure in <filename>/etc/nsswitch.conf</filename>.
description = lib.mdDoc ''
List of services entries to configure in {file}`/etc/nsswitch.conf`.
Note that "files" is always prepended.

26
nixos/modules/config/pulseaudio.nix
View file

@ -89,7 +89,7 @@ in {
enable = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Whether to enable the PulseAudio sound server.
'';
};
@ -97,7 +97,7 @@ in {
systemWide = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
If false, a PulseAudio server is launched automatically for
each user that tries to use the sound system. The server runs
with user privileges. If true, one system-wide PulseAudio
@ -112,7 +112,7 @@ in {
support32Bit = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Whether to include the 32-bit pulseaudio libraries in the system or not.
This is only useful on 64-bit systems and currently limited to x86_64-linux.
'';
@ -120,7 +120,7 @@ in {
configFile = mkOption {
type = types.nullOr types.path;
description = ''
description = lib.mdDoc ''
The path to the default configuration options the PulseAudio server
should use. By default, the "default.pa" configuration
from the PulseAudio distribution is used.
@ -130,8 +130,8 @@ in {
extraConfig = mkOption {
type = types.lines;
default = "";
description = ''
Literal string to append to <literal>configFile</literal>
description = lib.mdDoc ''
Literal string to append to `configFile`
and the config file generated by the pulseaudio module.
'';
};
@ -139,7 +139,7 @@ in {
extraClientConf = mkOption {
type = types.lines;
default = "";
description = ''
description = lib.mdDoc ''
Extra configuration appended to pulse/client.conf file.
'';
};
@ -151,10 +151,10 @@ in {
else pkgs.pulseaudio;
defaultText = literalExpression "pkgs.pulseaudio";
example = literalExpression "pkgs.pulseaudioFull";
description = ''
description = lib.mdDoc ''
The PulseAudio derivation to use. This can be used to enable
features (such as JACK support, Bluetooth) via the
<literal>pulseaudioFull</literal> package.
`pulseaudioFull` package.
'';
};
@ -162,7 +162,7 @@ in {
type = types.listOf types.package;
default = [];
example = literalExpression "[ pkgs.pulseaudio-modules-bt ]";
description = ''
description = lib.mdDoc ''
Extra pulseaudio modules to use. This is intended for out-of-tree
pulseaudio modules like extra bluetooth codecs.
@ -174,7 +174,7 @@ in {
logLevel = mkOption {
type = types.str;
default = "notice";
description = ''
description = lib.mdDoc ''
The log level that the system-wide pulseaudio daemon should use,
if activated.
'';
@ -183,7 +183,7 @@ in {
config = mkOption {
type = types.attrsOf types.unspecified;
default = {};
description = "Config of the pulse daemon. See <literal>man pulse-daemon.conf</literal>.";
description = lib.mdDoc "Config of the pulse daemon. See `man pulse-daemon.conf`.";
example = literalExpression ''{ realtime-scheduling = "yes"; }'';
};
};
@ -205,7 +205,7 @@ in {
type = types.listOf types.str;
default = [];
example = literalExpression ''[ "127.0.0.1" "192.168.1.0/24" ]'';
description = ''
description = lib.mdDoc ''
A list of IP subnets that are allowed to stream to the server.
'';
};

6
nixos/modules/config/unix-odbc-drivers.nix
View file

@ -20,10 +20,10 @@ in {
type = types.listOf types.package;
default = [];
example = literalExpression "with pkgs.unixODBCDrivers; [ sqlite psql ]";
description = ''
description = lib.mdDoc ''
Specifies Unix ODBC drivers to be registered in
<filename>/etc/odbcinst.ini</filename>. You may also want to
add <literal>pkgs.unixODBC</literal> to the system path to get
{file}`/etc/odbcinst.ini`. You may also want to
add `pkgs.unixODBC` to the system path to get
a command line client to connect to ODBC databases.
'';
};

4
nixos/modules/config/xdg/autostart.nix
View file

@ -10,9 +10,9 @@ with lib;
xdg.autostart.enable = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Whether to install files to support the
<link xlink:href="https://specifications.freedesktop.org/autostart-spec/autostart-spec-latest.html">XDG Autostart specification</link>.
[XDG Autostart specification](https://specifications.freedesktop.org/autostart-spec/autostart-spec-latest.html).
'';
};
};

4
nixos/modules/config/xdg/icons.nix
View file

@ -10,9 +10,9 @@ with lib;
xdg.icons.enable = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Whether to install files to support the
<link xlink:href="https://specifications.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html">XDG Icon Theme specification</link>.
[XDG Icon Theme specification](https://specifications.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html).
'';
};
};

4
nixos/modules/config/xdg/menus.nix
View file

@ -10,9 +10,9 @@ with lib;
xdg.menus.enable = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Whether to install files to support the
<link xlink:href="https://specifications.freedesktop.org/menu-spec/menu-spec-latest.html">XDG Desktop Menu specification</link>.
[XDG Desktop Menu specification](https://specifications.freedesktop.org/menu-spec/menu-spec-latest.html).
'';
};
};

4
nixos/modules/config/xdg/sounds.nix
View file

@ -10,9 +10,9 @@ with lib;
xdg.sounds.enable = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Whether to install files to support the
<link xlink:href="https://www.freedesktop.org/wiki/Specifications/sound-theme-spec/">XDG Sound Theme specification</link>.
[XDG Sound Theme specification](https://www.freedesktop.org/wiki/Specifications/sound-theme-spec/).
'';
};
};