nixos/pipewire: Fix capitalization

In docs PipeWire and WirePlumber should be capitalized as in this
sentence.
This commit is contained in:
Hans Christian Schmitz 2024-02-23 08:28:48 +01:00
parent 0bccbcf89c
commit 992582fdf8
No known key found for this signature in database
GPG Key ID: 1D729DE4757DE669
2 changed files with 9 additions and 9 deletions

View File

@ -1,4 +1,4 @@
# pipewire service.
# PipeWire service.
{ config, lib, pkgs, ... }:
with lib;
@ -25,7 +25,7 @@ in {
###### interface
options = {
services.pipewire = {
enable = mkEnableOption (lib.mdDoc "pipewire service");
enable = mkEnableOption (lib.mdDoc "PipeWire service");
package = mkPackageOption pkgs "pipewire" { };
@ -33,7 +33,7 @@ in {
default = true;
type = types.bool;
description = lib.mdDoc ''
Automatically run pipewire when connections are made to the pipewire socket.
Automatically run PipeWire when connections are made to the PipeWire socket.
'';
};
@ -301,7 +301,7 @@ in {
"audio"
"video"
] ++ lib.optional config.security.rtkit.enable "rtkit";
description = "Pipewire system service user";
description = "PipeWire system service user";
isSystemUser = true;
home = "/var/lib/pipewire";
createHome = true;

View File

@ -14,14 +14,14 @@ in
type = lib.types.bool;
default = config.services.pipewire.enable;
defaultText = lib.literalExpression "config.services.pipewire.enable";
description = lib.mdDoc "Whether to enable Wireplumber, a modular session / policy manager for PipeWire";
description = lib.mdDoc "Whether to enable WirePlumber, a modular session / policy manager for PipeWire";
};
package = lib.mkOption {
type = lib.types.package;
default = pkgs.wireplumber;
defaultText = lib.literalExpression "pkgs.wireplumber";
description = lib.mdDoc "The wireplumber derivation to use.";
description = lib.mdDoc "The WirePlumber derivation to use.";
};
};
};
@ -30,7 +30,7 @@ in
assertions = [
{
assertion = !config.hardware.bluetooth.hsphfpd.enable;
message = "Using Wireplumber conflicts with hsphfpd, as it provides the same functionality. `hardware.bluetooth.hsphfpd.enable` needs be set to false";
message = "Using WirePlumber conflicts with hsphfpd, as it provides the same functionality. `hardware.bluetooth.hsphfpd.enable` needs be set to false";
}
];
@ -38,7 +38,7 @@ in
environment.etc."wireplumber/main.lua.d/80-nixos.lua" = lib.mkIf (!pwUsedForAudio) {
text = ''
-- Pipewire is not used for audio, so prevent it from grabbing audio devices
-- PipeWire is not used for audio, so prevent it from grabbing audio devices
alsa_monitor.enable = function() end
'';
};
@ -66,7 +66,7 @@ in
systemd.user.services.wireplumber.wantedBy = [ "pipewire.service" ];
systemd.services.wireplumber.environment = lib.mkIf config.services.pipewire.systemWide {
# Force wireplumber to use system dbus.
# Force WirePlumber to use system dbus.
DBUS_SESSION_BUS_ADDRESS = "unix:path=/run/dbus/system_bus_socket";
};
};