From ee6866a947388843f6a556002da8997eaa8d8801 Mon Sep 17 00:00:00 2001
From: Wim Taymans <wtaymans@redhat.com>
Date: Wed, 8 Mar 2023 09:28:44 +0100
Subject: [PATCH] pulse-server: add doc about pulse.cmd section

---
 src/modules/module-protocol-pulse.c | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/src/modules/module-protocol-pulse.c b/src/modules/module-protocol-pulse.c
index 3863f0c17..2fe8930a3 100644
--- a/src/modules/module-protocol-pulse.c
+++ b/src/modules/module-protocol-pulse.c
@@ -194,6 +194,23 @@
  * VMs usually can't support the low latency settings that are possible on real
  * hardware.
  *
+ * ## Command execution
+ *
+ * As part of the server startup sequence, a set of commands can be executed.
+ * Currently, this can be used to load additional modules into the server.
+ *
+ *\code{.unparsed}
+ * # Extra commands can be executed here.
+ * #   load-module : loads a module with args and flags
+ * #      args = "<module-name> <module-args>"
+ * #      flags = [ "no-fail" ]
+ * pulse.cmd = [
+ *     { cmd = "load-module" args = "module-always-sink" flags = [ ] }
+ *     #{ cmd = "load-module" args = "module-switch-on-connect" }
+ *     #{ cmd = "load-module" args = "module-gsettings" flags = [ "nofail" ] }
+ * ]
+ *\endcode
+ *
  * ## Stream settings and rules
  *
  * Streams created by module-protocol-pulse will use the stream.properties