Merge pull request #292326 from hcsch/pipewire-wireplumber-doc-fix

nixos/pipewire: doc fixes as a follow-up to #282377 and #291946
This commit is contained in:
K900 2024-03-01 09:28:17 +03:00 committed by GitHub
commit 690d54ef45
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 11 additions and 3 deletions

View file

@ -246,6 +246,9 @@ in {
description = lib.mdDoc ''
List of packages that provide PipeWire configuration, in the form of
`share/pipewire/*/*.conf` files.
LV2 dependencies will be picked up from config packages automatically
via `passthru.requiredLv2Packages`.
'';
};
@ -258,7 +261,8 @@ in {
be made available to PipeWire for [filter chains][wiki-filter-chain].
Config packages have their required LV2 plugins added automatically,
so they don't need to be specified here.
so they don't need to be specified here. Config packages need to set
`passthru.requiredLv2Packages` for this to work.
[wiki-filter-chain]: https://docs.pipewire.org/page_module_filter_chain.html
'';

View file

@ -30,6 +30,9 @@ in
description = lib.mdDoc ''
List of packages that provide WirePlumber configuration, in the form of
`share/wireplumber/*/*.lua` files.
LV2 dependencies will be picked up from config packages automatically
via `passthru.requiredLv2Packages`.
'';
};
@ -42,7 +45,8 @@ in
be made available to WirePlumber for [filter chains][wiki-filter-chain].
Config packages have their required LV2 plugins added automatically,
so they don't need to be specified here.
so they don't need to be specified here. Config packages need to set
`passthru.requiredLv2Packages` for this to work.
[wiki-filter-chain]: https://docs.pipewire.org/page_module_filter_chain.html
'';
@ -108,7 +112,7 @@ in
)
config.environment.etc
)) == 1;
message = "Using `environment.etc.\"wireplumber<...>\"` directly is no longer supported in 24.05. Use `services.wireplumber.configPackages` instead.";
message = "Using `environment.etc.\"wireplumber<...>\"` directly is no longer supported in 24.05. Use `services.pipewire.wireplumber.configPackages` instead.";
}
];