nordic-dev.net/nixpkgs
nordic-dev.net/nixpkgs
2
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2024-11-27 17:33:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #182098 from pennae/option-doc-md

Browse Source 
convert some varlists in option docs to MD
This commit is contained in:
pennae 2022-07-24 13:14:40 +02:00 committed by GitHub
commit ff56c775c8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 72 additions and 165 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
nixos/modules/config/qt5.nix
View File

@ -45,41 +45,17 @@ in
["lxqt" "lxqt-qtplugin"] ["lxqt" "lxqt-qtplugin"]
["libsForQt5" "plasma-integration"] ["libsForQt5" "plasma-integration"]
]; ];
description = '' description = lib.mdDoc ''
Selects the platform theme to use for Qt5 applications.</para> Selects the platform theme to use for Qt5 applications.
<para>The options are
<variablelist> The options are
<varlistentry> - `gtk`: Use GTK theme with [qtstyleplugins](https://github.com/qt/qtstyleplugins)
<term><literal>gtk</literal></term> - `gnome`: Use GNOME theme with [qgnomeplatform](https://github.com/FedoraQt/QGnomePlatform)
<listitem><para>Use GTK theme with - `lxqt`: Use LXQt style set using the [lxqt-config-appearance](https://github.com/lxqt/lxqt-config)
<link xlink:href="https://github.com/qt/qtstyleplugins">qtstyleplugins</link> application.
</para></listitem> - `qt5ct`: Use Qt style set using the [qt5ct](https://sourceforge.net/projects/qt5ct/)
</varlistentry> application.
<varlistentry> - `kde`: Use Qt settings from Plasma.
<term><literal>gnome</literal></term>
<listitem><para>Use GNOME theme with
<link xlink:href="https://github.com/FedoraQt/QGnomePlatform">qgnomeplatform</link>
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>lxqt</literal></term>
<listitem><para>Use LXQt style set using the
<link xlink:href="https://github.com/lxqt/lxqt-config">lxqt-config-appearance</link>
application.
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>qt5ct</literal></term>
<listitem><para>Use Qt style set using the
<link xlink:href="https://sourceforge.net/projects/qt5ct/">qt5ct</link>
application.
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>kde</literal></term>
<listitem><para>Use Qt settings from Plasma.</para></listitem>
</varlistentry>
</variablelist>
''; '';
}; };
@ -97,27 +73,14 @@ in
"adwaita-qt" "adwaita-qt"
["libsForQt5" "qtstyleplugins"] ["libsForQt5" "qtstyleplugins"]
]; ];
description = '' description = lib.mdDoc ''
Selects the style to use for Qt5 applications.</para> Selects the style to use for Qt5 applications.
<para>The options are
<variablelist> The options are
<varlistentry> - `adwaita`, `adwaita-dark`: Use Adwaita Qt style with
<term><literal>adwaita</literal></term> [adwaita](https://github.com/FedoraQt/adwaita-qt)
<term><literal>adwaita-dark</literal></term> - `cleanlooks`, `gtk2`, `motif`, `plastique`: Use styles from
<listitem><para>Use Adwaita Qt style with [qtstyleplugins](https://github.com/qt/qtstyleplugins)
<link xlink:href="https://github.com/FedoraQt/adwaita-qt">adwaita</link>
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>cleanlooks</literal></term>
<term><literal>gtk2</literal></term>
<term><literal>motif</literal></term>
<term><literal>plastique</literal></term>
<listitem><para>Use styles from
<link xlink:href="https://github.com/qt/qtstyleplugins">qtstyleplugins</link>
</para></listitem>
</varlistentry>
</variablelist>
''; '';
}; };
}; };

59
nixos/modules/system/boot/resolved.nix
View File

@ -15,7 +15,7 @@ in
services.resolved.enable = mkOption { services.resolved.enable = mkOption {
default = false; default = false;
type = types.bool; type = types.bool;
description = '' description = lib.mdDoc ''
Whether to enable the systemd DNS resolver daemon. Whether to enable the systemd DNS resolver daemon.
''; '';
}; };
@ -24,7 +24,7 @@ in
default = [ ]; default = [ ];
example = [ "8.8.8.8" "2001:4860:4860::8844" ]; example = [ "8.8.8.8" "2001:4860:4860::8844" ];
type = types.listOf types.str; type = types.listOf types.str;
description = '' description = lib.mdDoc ''
A list of IPv4 and IPv6 addresses to use as the fallback DNS servers. A list of IPv4 and IPv6 addresses to use as the fallback DNS servers.
If this option is empty, a compiled-in list of DNS servers is used instead. If this option is empty, a compiled-in list of DNS servers is used instead.
''; '';
@ -35,7 +35,7 @@ in
defaultText = literalExpression "config.networking.search"; defaultText = literalExpression "config.networking.search";
example = [ "example.com" ]; example = [ "example.com" ];
type = types.listOf types.str; type = types.listOf types.str;
description = '' description = lib.mdDoc ''
A list of domains. These domains are used as search suffixes A list of domains. These domains are used as search suffixes
when resolving single-label host names (domain names which when resolving single-label host names (domain names which
contain no dot), in order to qualify them into fully-qualified contain no dot), in order to qualify them into fully-qualified
@ -43,7 +43,7 @@ in
For compatibility reasons, if this setting is not specified, For compatibility reasons, if this setting is not specified,
the search domains listed in the search domains listed in
<filename>/etc/resolv.conf</filename> are used instead, if {file}`/etc/resolv.conf` are used instead, if
that file exists and any domains are configured in it. that file exists and any domains are configured in it.
''; '';
}; };
@ -52,32 +52,14 @@ in
default = "true"; default = "true";
example = "false"; example = "false";
type = types.enum [ "true" "resolve" "false" ]; type = types.enum [ "true" "resolve" "false" ];
description = '' description = lib.mdDoc ''
Controls Link-Local Multicast Name Resolution support Controls Link-Local Multicast Name Resolution support
(RFC 4795) on the local host. (RFC 4795) on the local host.
If set to If set to
- `"true"`: Enables full LLMNR responder and resolver support.
<variablelist> - `"false"`: Disables both.
<varlistentry> - `"resolve"`: Only resolution support is enabled, but responding is disabled.
<term><literal>"true"</literal></term>
<listitem><para>
Enables full LLMNR responder and resolver support.
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>"false"</literal></term>
<listitem><para>
Disables both.
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>"resolve"</literal></term>
<listitem><para>
Only resolution support is enabled, but responding is disabled.
</para></listitem>
</varlistentry>
</variablelist>
''; '';
}; };
@ -85,21 +67,14 @@ in
default = "allow-downgrade"; default = "allow-downgrade";
example = "true"; example = "true";
type = types.enum [ "true" "allow-downgrade" "false" ]; type = types.enum [ "true" "allow-downgrade" "false" ];
description = '' description = lib.mdDoc ''
If set to If set to
<variablelist> - `"true"`:
<varlistentry>
<term><literal>"true"</literal></term>
<listitem><para>
all DNS lookups are DNSSEC-validated locally (excluding all DNS lookups are DNSSEC-validated locally (excluding
LLMNR and Multicast DNS). Note that this mode requires a LLMNR and Multicast DNS). Note that this mode requires a
DNS server that supports DNSSEC. If the DNS server does DNS server that supports DNSSEC. If the DNS server does
not properly support DNSSEC all validations will fail. not properly support DNSSEC all validations will fail.
</para></listitem> - `"allow-downgrade"`:
</varlistentry>
<varlistentry>
<term><literal>"allow-downgrade"</literal></term>
<listitem><para>
DNSSEC validation is attempted, but if the server does not DNSSEC validation is attempted, but if the server does not
support DNSSEC properly, DNSSEC mode is automatically support DNSSEC properly, DNSSEC mode is automatically
disabled. Note that this mode makes DNSSEC validation disabled. Note that this mode makes DNSSEC validation
@ -107,22 +82,14 @@ in
be able to trigger a downgrade to non-DNSSEC mode by be able to trigger a downgrade to non-DNSSEC mode by
synthesizing a DNS response that suggests DNSSEC was not synthesizing a DNS response that suggests DNSSEC was not
supported. supported.
</para></listitem> - `"false"`: DNS lookups are not DNSSEC validated.
</varlistentry>
<varlistentry>
<term><literal>"false"</literal></term>
<listitem><para>
DNS lookups are not DNSSEC validated.
</para></listitem>
</varlistentry>
</variablelist>
''; '';
}; };
services.resolved.extraConfig = mkOption { services.resolved.extraConfig = mkOption {
default = ""; default = "";
type = types.lines; type = types.lines;
description = '' description = lib.mdDoc ''
Extra config to append to resolved.conf. Extra config to append to resolved.conf.
''; '';
}; };

103
nixos/modules/virtualisation/oci-containers.nix
View File

@ -14,18 +14,18 @@ let
image = mkOption { image = mkOption {
type = with types; str; type = with types; str;
description = "OCI image to run."; description = lib.mdDoc "OCI image to run.";
example = "library/hello-world"; example = "library/hello-world";
}; };
imageFile = mkOption { imageFile = mkOption {
type = with types; nullOr package; type = with types; nullOr package;
default = null; default = null;
description = '' description = lib.mdDoc ''
Path to an image file to load before running the image. This can Path to an image file to load before running the image. This can
be used to bypass pulling the image from the registry. be used to bypass pulling the image from the registry.
The <literal>image</literal> attribute must match the name and The `image` attribute must match the name and
tag of the image contained in this file, as they will be used to tag of the image contained in this file, as they will be used to
run the container with that image. If they do not match, the run the container with that image. If they do not match, the
image will be pulled from the registry as usual. image will be pulled from the registry as usual.
@ -38,20 +38,20 @@ let
username = mkOption { username = mkOption {
type = with types; nullOr str; type = with types; nullOr str;
default = null; default = null;
description = "Username for login."; description = lib.mdDoc "Username for login.";
}; };
passwordFile = mkOption { passwordFile = mkOption {
type = with types; nullOr str; type = with types; nullOr str;
default = null; default = null;
description = "Path to file containing password."; description = lib.mdDoc "Path to file containing password.";
example = "/etc/nixos/dockerhub-password.txt"; example = "/etc/nixos/dockerhub-password.txt";
}; };
registry = mkOption { registry = mkOption {
type = with types; nullOr str; type = with types; nullOr str;
default = null; default = null;
description = "Registry where to login to."; description = lib.mdDoc "Registry where to login to.";
example = "https://docker.pkg.github.com"; example = "https://docker.pkg.github.com";
}; };
@ -60,7 +60,7 @@ let
cmd = mkOption { cmd = mkOption {
type = with types; listOf str; type = with types; listOf str;
default = []; default = [];
description = "Commandline arguments to pass to the image's entrypoint."; description = lib.mdDoc "Commandline arguments to pass to the image's entrypoint.";
example = literalExpression '' example = literalExpression ''
["--port=9000"] ["--port=9000"]
''; '';
@ -68,7 +68,7 @@ let
entrypoint = mkOption { entrypoint = mkOption {
type = with types; nullOr str; type = with types; nullOr str;
description = "Override the default entrypoint of the image."; description = lib.mdDoc "Override the default entrypoint of the image.";
default = null; default = null;
example = "/bin/my-app"; example = "/bin/my-app";
}; };
@ -76,7 +76,7 @@ let
environment = mkOption { environment = mkOption {
type = with types; attrsOf str; type = with types; attrsOf str;
default = {}; default = {};
description = "Environment variables to set for this container."; description = lib.mdDoc "Environment variables to set for this container.";
example = literalExpression '' example = literalExpression ''
{ {
DATABASE_HOST = "db.example.com"; DATABASE_HOST = "db.example.com";
@ -88,7 +88,7 @@ let
environmentFiles = mkOption { environmentFiles = mkOption {
type = with types; listOf path; type = with types; listOf path;
default = []; default = [];
description = "Environment files for this container."; description = lib.mdDoc "Environment files for this container.";
example = literalExpression '' example = literalExpression ''
[ [
/path/to/.env /path/to/.env
@ -100,15 +100,15 @@ let
log-driver = mkOption { log-driver = mkOption {
type = types.str; type = types.str;
default = "journald"; default = "journald";
description = '' description = lib.mdDoc ''
Logging driver for the container. The default of Logging driver for the container. The default of
<literal>"journald"</literal> means that the container's logs will be `"journald"` means that the container's logs will be
handled as part of the systemd unit. handled as part of the systemd unit.
For more details and a full list of logging drivers, refer to respective backends documentation. For more details and a full list of logging drivers, refer to respective backends documentation.
For Docker: For Docker:
<link xlink:href="https://docs.docker.com/engine/reference/run/#logging-drivers---log-driver">Docker engine documentation</link> [Docker engine documentation](https://docs.docker.com/engine/reference/run/#logging-drivers---log-driver)
For Podman: For Podman:
Refer to the docker-run(1) man page. Refer to the docker-run(1) man page.
@ -118,49 +118,27 @@ let
ports = mkOption { ports = mkOption {
type = with types; listOf str; type = with types; listOf str;
default = []; default = [];
description = '' description = lib.mdDoc ''
Network ports to publish from the container to the outer host. Network ports to publish from the container to the outer host.
Valid formats: Valid formats:
- `<ip>:<hostPort>:<containerPort>`
- `<ip>::<containerPort>`
- `<hostPort>:<containerPort>`
- `<containerPort>`
<itemizedlist> Both `hostPort` and `containerPort` can be specified as a range of
<listitem>
<para>
<literal>&lt;ip&gt;:&lt;hostPort&gt;:&lt;containerPort&gt;</literal>
</para>
</listitem>
<listitem>
<para>
<literal>&lt;ip&gt;::&lt;containerPort&gt;</literal>
</para>
</listitem>
<listitem>
<para>
<literal>&lt;hostPort&gt;:&lt;containerPort&gt;</literal>
</para>
</listitem>
<listitem>
<para>
<literal>&lt;containerPort&gt;</literal>
</para>
</listitem>
</itemizedlist>
Both <literal>hostPort</literal> and
<literal>containerPort</literal> can be specified as a range of
ports. When specifying ranges for both, the number of container ports. When specifying ranges for both, the number of container
ports in the range must match the number of host ports in the ports in the range must match the number of host ports in the
range. Example: <literal>1234-1236:1234-1236/tcp</literal> range. Example: `1234-1236:1234-1236/tcp`
When specifying a range for <literal>hostPort</literal> only, the When specifying a range for `hostPort` only, the `containerPort`
<literal>containerPort</literal> must <emphasis>not</emphasis> be a must *not* be a range. In this case, the container port is published
range. In this case, the container port is published somewhere somewhere within the specified `hostPort` range.
within the specified <literal>hostPort</literal> range. Example: Example: `1234-1236:1234/tcp`
<literal>1234-1236:1234/tcp</literal>
Refer to the Refer to the
<link xlink:href="https://docs.docker.com/engine/reference/run/#expose-incoming-ports"> [Docker engine documentation](https://docs.docker.com/engine/reference/run/#expose-incoming-ports) for full details.
Docker engine documentation</link> for full details.
''; '';
example = literalExpression '' example = literalExpression ''
[ [
@ -172,7 +150,7 @@ let
user = mkOption { user = mkOption {
type = with types; nullOr str; type = with types; nullOr str;
default = null; default = null;
description = '' description = lib.mdDoc ''
Override the username or UID (and optionally groupname or GID) used Override the username or UID (and optionally groupname or GID) used
in the container. in the container.
''; '';
@ -182,16 +160,15 @@ let
volumes = mkOption { volumes = mkOption {
type = with types; listOf str; type = with types; listOf str;
default = []; default = [];
description = '' description = lib.mdDoc ''
List of volumes to attach to this container. List of volumes to attach to this container.
Note that this is a list of <literal>"src:dst"</literal> strings to Note that this is a list of `"src:dst"` strings to
allow for <literal>src</literal> to refer to allow for `src` to refer to `/nix/store` paths, which
<literal>/nix/store</literal> paths, which would be difficult with an would be difficult with an attribute set. There are
attribute set. There are also a variety of mount options available also a variety of mount options available as a third
as a third field; please refer to the field; please refer to the
<link xlink:href="https://docs.docker.com/engine/reference/run/#volume-shared-filesystems"> [docker engine documentation](https://docs.docker.com/engine/reference/run/#volume-shared-filesystems) for details.
docker engine documentation</link> for details.
''; '';
example = literalExpression '' example = literalExpression ''
[ [
@ -204,17 +181,17 @@ let
workdir = mkOption { workdir = mkOption {
type = with types; nullOr str; type = with types; nullOr str;
default = null; default = null;
description = "Override the default working directory for the container."; description = lib.mdDoc "Override the default working directory for the container.";
example = "/var/lib/hello_world"; example = "/var/lib/hello_world";
}; };
dependsOn = mkOption { dependsOn = mkOption {
type = with types; listOf str; type = with types; listOf str;
default = []; default = [];
description = '' description = lib.mdDoc ''
Define which other containers this one depends on. They will be added to both After and Requires for the unit. Define which other containers this one depends on. They will be added to both After and Requires for the unit.
Use the same name as the attribute under <literal>virtualisation.oci-containers.containers</literal>. Use the same name as the attribute under `virtualisation.oci-containers.containers`.
''; '';
example = literalExpression '' example = literalExpression ''
virtualisation.oci-containers.containers = { virtualisation.oci-containers.containers = {
@ -229,7 +206,7 @@ let
extraOptions = mkOption { extraOptions = mkOption {
type = with types; listOf str; type = with types; listOf str;
default = []; default = [];
description = "Extra options for <command>${defaultBackend} run</command>."; description = lib.mdDoc "Extra options for {command}`${defaultBackend} run`.";
example = literalExpression '' example = literalExpression ''
["--network=host"] ["--network=host"]
''; '';
@ -238,7 +215,7 @@ let
autoStart = mkOption { autoStart = mkOption {
type = types.bool; type = types.bool;
default = true; default = true;
description = '' description = lib.mdDoc ''
When enabled, the container is automatically started on boot. When enabled, the container is automatically started on boot.
If this option is set to false, the container has to be started on-demand via its service. If this option is set to false, the container has to be started on-demand via its service.
''; '';
@ -339,13 +316,13 @@ in {
backend = mkOption { backend = mkOption {
type = types.enum [ "podman" "docker" ]; type = types.enum [ "podman" "docker" ];
default = if versionAtLeast config.system.stateVersion "22.05" then "podman" else "docker"; default = if versionAtLeast config.system.stateVersion "22.05" then "podman" else "docker";
description = "The underlying Docker implementation to use."; description = lib.mdDoc "The underlying Docker implementation to use.";
}; };
containers = mkOption { containers = mkOption {
default = {}; default = {};
type = types.attrsOf (types.submodule containerOptions); type = types.attrsOf (types.submodule containerOptions);
description = "OCI (Docker) containers to run as systemd services."; description = lib.mdDoc "OCI (Docker) containers to run as systemd services.";
}; };
}; };