doc: suggest fragment file name in example configs

This commit is contained in:
Pauli Virtanen 2024-10-31 21:13:50 +02:00 committed by Wim Taymans
parent 9c19284f7f
commit 5e8a7f434b
3 changed files with 39 additions and 33 deletions

View file

@ -40,6 +40,19 @@
* There are no module-specific options, all arguments are passed to * There are no module-specific options, all arguments are passed to
* \ref page_module_jack_tunnel. * \ref page_module_jack_tunnel.
* *
* ## Config override
*
* A `module.jackdbus-detect.args` config section can be added
* to override the module arguments.
*
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-jack-dbus-detect-args.conf
*
* module.jackdbus-detect.args = {
* #tunnel.mode = duplex
* }
*\endcode
*
* ## Example configuration * ## Example configuration
*\code{.unparsed} *\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-jack-dbus-detect.conf * # ~/.config/pipewire/pipewire.conf.d/my-jack-dbus-detect.conf
@ -61,17 +74,6 @@
* } * }
* ] * ]
*\endcode *\endcode
* ## Config override
*
* A `module.jackdbus-detect.args` config section can be added in the override directory
* to override the module arguments.
*
*\code{.unparsed}
* module.jackdbus-detect.args = {
* #tunnel.mode = duplex
* }
*\endcode
* *
*/ */

View file

@ -40,6 +40,19 @@
* on every processing cycle. This allows trading off * on every processing cycle. This allows trading off
* CPU usage for profiling accuracy. Default 0 * CPU usage for profiling accuracy. Default 0
* *
* ## Config override
*
* A `module.profiler.args` config section can be added
* to override the module arguments.
*
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-profiler-args.conf
*
* module.profiler.args = {
* #profile.interval.ms = 10
* }
*\endcode
*
* ## Example configuration * ## Example configuration
* *
* The module has no arguments and is usually added to the config file of * The module has no arguments and is usually added to the config file of
@ -54,17 +67,6 @@
* } * }
* ] * ]
*\endcode *\endcode
* ## Config override
*
* A `module.profiler.args` config section can be added in the override directory
* to override the module arguments.
*
*\code{.unparsed}
* module.profiler.args = {
* #profile.interval.ms = 10
* }
*\endcode
* *
* ## See also * ## See also
* *

View file

@ -95,6 +95,19 @@
* *
* The PipeWire server processes are explicitly configured with a valid nice level. * The PipeWire server processes are explicitly configured with a valid nice level.
* *
* ## Config override
*
* A `module.rt.args` config section can be added
* to override the module arguments.
*
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-rt-args.conf
*
* module.rt.args = {
* #nice.level = 22
* }
*\endcode
*
* ## Example configuration * ## Example configuration
* *
*\code{.unparsed} *\code{.unparsed}
@ -115,17 +128,6 @@
* } * }
* ] * ]
*\endcode *\endcode
*
* ## Config override
*
* A `module.rt.args` config section can be added in the override directory
* to override the module arguments.
*
*\code{.unparsed}
* module.rt.args = {
* nice.level = 22
* }
*\endcode
*/ */
#define NAME "rt" #define NAME "rt"