diff options
author | pennae <github@quasiparticle.net> | 2022-07-19 15:05:45 +0200 |
---|---|---|
committer | pennae <github@quasiparticle.net> | 2022-07-24 13:01:18 +0200 |
commit | 8a79dfd94a77a07cc5afab2e2aaeb7b99f0b8039 (patch) | |
tree | 85dce476f0083aeadd6f5c1783cb675296ad9c86 /nixos/modules/config/pulseaudio.nix | |
parent | d2db10786f27619d5519b12b03fb10dc8ca95e59 (diff) | |
download | nixpkgs-8a79dfd94a77a07cc5afab2e2aaeb7b99f0b8039.tar nixpkgs-8a79dfd94a77a07cc5afab2e2aaeb7b99f0b8039.tar.gz nixpkgs-8a79dfd94a77a07cc5afab2e2aaeb7b99f0b8039.tar.bz2 nixpkgs-8a79dfd94a77a07cc5afab2e2aaeb7b99f0b8039.tar.lz nixpkgs-8a79dfd94a77a07cc5afab2e2aaeb7b99f0b8039.tar.xz nixpkgs-8a79dfd94a77a07cc5afab2e2aaeb7b99f0b8039.tar.zst nixpkgs-8a79dfd94a77a07cc5afab2e2aaeb7b99f0b8039.zip |
nixos/config: invariant option docs MD conversions
Diffstat (limited to 'nixos/modules/config/pulseaudio.nix')
-rw-r--r-- | nixos/modules/config/pulseaudio.nix | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/nixos/modules/config/pulseaudio.nix b/nixos/modules/config/pulseaudio.nix index 01555d28b73..aa3ca549f09 100644 --- a/nixos/modules/config/pulseaudio.nix +++ b/nixos/modules/config/pulseaudio.nix @@ -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. ''; }; |