From 19d78ef195187a20a818c1c1d95d69156a3f3577 Mon Sep 17 00:00:00 2001
From: Wim Taymans <wtaymans@redhat.com>
Date: Fri, 24 Jan 2025 13:13:23 +0100
Subject: [PATCH] module: improve loopback docs

---
 src/modules/module-loopback.c        | 30 ++++++++++++++++++++++++++++
 src/modules/module-protocol-native.c |  2 +-
 2 files changed, 31 insertions(+), 1 deletion(-)

diff --git a/src/modules/module-loopback.c b/src/modules/module-loopback.c
index db3b5725e..f4b068be7 100644
--- a/src/modules/module-loopback.c
+++ b/src/modules/module-loopback.c
@@ -78,6 +78,36 @@
  * to and from this common channel layout. This can be used to implement up or
  * downmixing loopback sinks/sources.
  *
+ * ## Example configuration of source to sink link
+ *
+ * This loopback links a source node to a sink node. You can change the target.object
+ * properties to match your source/sink node.name.
+ *
+ *\code{.unparsed}
+ * # ~/.config/pipewire/pipewire.conf.d/my-loopback-0.conf
+ *
+ * context.modules = [
+ * {   name = libpipewire-module-loopback
+ *     args = {
+ *         capture.props = {
+ *             #  if you want to capture sink monitor ports,
+ *             #  uncomment the next line and set the target.object
+ *             #  to the sink name.
+ *             #stream.capture.sink = true
+ *             target.object = "alsa_input.usb-C-Media_Electronics_Inc._TONOR_TC-777_Audio_Device-00.mono-fallback"
+ *             node.passive = true
+ *             node.dont-reconnect = true
+ *         }
+ *         playback.props = {
+ *             target.object = "alsa_output.usb-0d8c_USB_Sound_Device-00.analog-surround-71"
+ *             node.dont-reconnect = true
+ *             node.passive = true
+ *         }
+ *     }
+ * }
+ * ]
+ *\endcode
+ *
  * ## Example configuration of a virtual sink
  *
  * This Virtual sink routes stereo input to the rear channels of a 7.1 sink.
diff --git a/src/modules/module-protocol-native.c b/src/modules/module-protocol-native.c
index c63ae2117..d1d0976b7 100644
--- a/src/modules/module-protocol-native.c
+++ b/src/modules/module-protocol-native.c
@@ -70,7 +70,7 @@ PW_LOG_TOPIC(mod_topic_connection, "conn." NAME);
  * a client and a server using unix local sockets.
  *
  * Normally this module is loaded in both client and server config files
- * so that they cam communicate.
+ * so that they can communicate.
  *
  * ## Module Name
  *