colin/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

nixos/pipewire: remove lib.mdDoc (no-op)

Browse Source
This commit is contained in:
éclairevoyant 2024-03-26 13:39:01 -04:00
parent ab14a429cb
commit f3b74afdc7
No known key found for this signature in database
GPG Key ID: E3813AEAA02DB54B
1 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
nixos/modules/services/desktops/pipewire/pipewire.nix
View File

@ -64,14 +64,14 @@ in {
###### interface ###### interface
options = { options = {
services.pipewire = { services.pipewire = {
enable = mkEnableOption (lib.mdDoc "PipeWire service"); enable = mkEnableOption "PipeWire service";
package = mkPackageOption pkgs "pipewire" { }; package = mkPackageOption pkgs "pipewire" { };
socketActivation = mkOption { socketActivation = mkOption {
default = true; default = true;
type = types.bool; type = types.bool;
description = lib.mdDoc '' description = ''
Automatically run PipeWire when connections are made to the PipeWire socket. Automatically run PipeWire when connections are made to the PipeWire socket.
''; '';
}; };
@ -82,35 +82,35 @@ in {
# this is for backwards compatibility # this is for backwards compatibility
default = cfg.alsa.enable || cfg.jack.enable || cfg.pulse.enable; default = cfg.alsa.enable || cfg.jack.enable || cfg.pulse.enable;
defaultText = lib.literalExpression "config.services.pipewire.alsa.enable || config.services.pipewire.jack.enable || config.services.pipewire.pulse.enable"; defaultText = lib.literalExpression "config.services.pipewire.alsa.enable || config.services.pipewire.jack.enable || config.services.pipewire.pulse.enable";
description = lib.mdDoc "Whether to use PipeWire as the primary sound server"; description = "Whether to use PipeWire as the primary sound server";
}; };
}; };
alsa = { alsa = {
enable = mkEnableOption (lib.mdDoc "ALSA support"); enable = mkEnableOption "ALSA support";
support32Bit = mkEnableOption (lib.mdDoc "32-bit ALSA support on 64-bit systems"); support32Bit = mkEnableOption "32-bit ALSA support on 64-bit systems";
}; };
jack = { jack = {
enable = mkEnableOption (lib.mdDoc "JACK audio emulation"); enable = mkEnableOption "JACK audio emulation";
}; };
raopOpenFirewall = mkOption { raopOpenFirewall = mkOption {
type = lib.types.bool; type = lib.types.bool;
default = false; default = false;
description = lib.mdDoc '' description = ''
Opens UDP/6001-6002, required by RAOP/Airplay for timing and control data. Opens UDP/6001-6002, required by RAOP/Airplay for timing and control data.
''; '';
}; };
pulse = { pulse = {
enable = mkEnableOption (lib.mdDoc "PulseAudio server emulation"); enable = mkEnableOption "PulseAudio server emulation";
}; };
systemWide = lib.mkOption { systemWide = lib.mkOption {
type = lib.types.bool; type = lib.types.bool;
default = false; default = false;
description = lib.mdDoc '' description = ''
If true, a system-wide PipeWire service and socket is enabled If true, a system-wide PipeWire service and socket is enabled
allowing all users in the "pipewire" group to use it simultaneously. allowing all users in the "pipewire" group to use it simultaneously.
If false, then user units are used instead, restricting access to If false, then user units are used instead, restricting access to
@ -138,7 +138,7 @@ in {
}; };
}; };
}; };
description = lib.mdDoc '' description = ''
Additional configuration for the PipeWire server. Additional configuration for the PipeWire server.
Every item in this attrset becomes a separate drop-in file in `/etc/pipewire/pipewire.conf.d`. Every item in this attrset becomes a separate drop-in file in `/etc/pipewire/pipewire.conf.d`.
@ -166,7 +166,7 @@ in {
}; };
}; };
}; };
description = lib.mdDoc '' description = ''
Additional configuration for the PipeWire client library, used by most applications. Additional configuration for the PipeWire client library, used by most applications.
Every item in this attrset becomes a separate drop-in file in `/etc/pipewire/client.conf.d`. Every item in this attrset becomes a separate drop-in file in `/etc/pipewire/client.conf.d`.
@ -186,7 +186,7 @@ in {
}; };
}; };
}; };
description = lib.mdDoc '' description = ''
Additional configuration for the PipeWire client library, used by real-time applications and legacy ALSA clients. Additional configuration for the PipeWire client library, used by real-time applications and legacy ALSA clients.
Every item in this attrset becomes a separate drop-in file in `/etc/pipewire/client-rt.conf.d`. Every item in this attrset becomes a separate drop-in file in `/etc/pipewire/client-rt.conf.d`.
@ -207,7 +207,7 @@ in {
}; };
}; };
}; };
description = lib.mdDoc '' description = ''
Additional configuration for the PipeWire JACK server and client library. Additional configuration for the PipeWire JACK server and client library.
Every item in this attrset becomes a separate drop-in file in `/etc/pipewire/jack.conf.d`. Every item in this attrset becomes a separate drop-in file in `/etc/pipewire/jack.conf.d`.
@ -232,7 +232,7 @@ in {
}]; }];
}; };
}; };
description = lib.mdDoc '' description = ''
Additional configuration for the PipeWire PulseAudio server. Additional configuration for the PipeWire PulseAudio server.
Every item in this attrset becomes a separate drop-in file in `/etc/pipewire/pipewire-pulse.conf.d`. Every item in this attrset becomes a separate drop-in file in `/etc/pipewire/pipewire-pulse.conf.d`.
@ -251,7 +251,7 @@ in {
configPackages = lib.mkOption { configPackages = lib.mkOption {
type = lib.types.listOf lib.types.package; type = lib.types.listOf lib.types.package;
default = []; default = [];
description = lib.mdDoc '' description = ''
List of packages that provide PipeWire configuration, in the form of List of packages that provide PipeWire configuration, in the form of
`share/pipewire/*/*.conf` files. `share/pipewire/*/*.conf` files.
@ -264,7 +264,7 @@ in {
type = lib.types.listOf lib.types.package; type = lib.types.listOf lib.types.package;
default = []; default = [];
example = lib.literalExpression "[ pkgs.lsp-plugins ]"; example = lib.literalExpression "[ pkgs.lsp-plugins ]";
description = lib.mdDoc '' description = ''
List of packages that provide LV2 plugins in `lib/lv2` that should List of packages that provide LV2 plugins in `lib/lv2` that should
be made available to PipeWire for [filter chains][wiki-filter-chain]. be made available to PipeWire for [filter chains][wiki-filter-chain].