From 163044ab1ebfd04db8fcf9c18b6bd1edb07d3f2f Mon Sep 17 00:00:00 2001
From: Pauli Virtanen <pav@iki.fi>
Date: Sun, 28 Jul 2024 18:21:25 +0300
Subject: [PATCH] doc: move configuration index to a separate page

Also add index to pipewire-props
---
 doc/dox/config/index.md            | 53 +-----------------------------
 doc/dox/config/pipewire-props.7.md | 22 +++++++++++++
 doc/dox/config/xref.md             | 51 ++++++++++++++++++++++++++++
 doc/meson.build                    |  1 +
 4 files changed, 75 insertions(+), 52 deletions(-)
 create mode 100644 doc/dox/config/xref.md

diff --git a/doc/dox/config/index.md b/doc/dox/config/index.md
index 7b5341cc9..861753447 100644
--- a/doc/dox/config/index.md
+++ b/doc/dox/config/index.md
@@ -31,6 +31,7 @@ Configuration of devices:
 
 - [WirePlumber configuration](https://pipewire.pages.freedesktop.org/wireplumber/daemon/configuration.html)
 - \ref page_man_pipewire-props_7 "Object property reference"
+- \subpage page_config_xref "Configuration Index"
 
 Configuration for client applications, either connecting via the
 native PipeWire interface, or the emulated ALSA, JACK, or PulseAudio
@@ -50,55 +51,3 @@ interfaces:
 - \subpage page_man_pipewire-props_7
 - \subpage page_man_pipewire-pulse-modules_7
 - \subpage page_man_libpipewire-modules_7
-
-# Configuration Index
-
-\ref page_man_pipewire_conf_5 "pipewire.conf"
-
-@SECREF@ pipewire.conf
-
-\ref page_man_pipewire-pulse_conf_5 "pipewire-pulse.conf"
-
-@SECREF@ pipewire-pulse.conf
-
-\ref page_man_pipewire-client_conf_5 "client.conf, client-rt.conf"
-
-@SECREF@ client.conf
-
-\ref page_man_pipewire-jack_conf_5 "jack.conf"
-
-@SECREF@ jack.conf
-
-**Runtime settings**
-
-@SECREF@ pipewire-settings
-
-**Environment variables**
-
-@SECREF@ pipewire-env client-env jack-env pulse-env
-
-**Object properties**
-
-@SECREF@ props
-
-**Monitor properties**
-
-@SECREF@ monitor-prop
-
-**Device properties**
-
-@SECREF@ device-prop
-
-**Node properties**
-
-@SECREF@ node-prop
-
-**Port properties**
-
-@SECREF@ port-prop
-
-**Client properties**
-
-@SECREF@ client-prop
-
-\see pw_keys in API documentation.
diff --git a/doc/dox/config/pipewire-props.7.md b/doc/dox/config/pipewire-props.7.md
index fa163bf4b..fc116b5ef 100644
--- a/doc/dox/config/pipewire-props.7.md
+++ b/doc/dox/config/pipewire-props.7.md
@@ -1119,6 +1119,28 @@ applications.
 The Profiler and SecurityContext objects only provide corresponding
 PipeWire APIs.
 
+# INDEX {#pipewire-props__index}
+
+## Monitor properties
+
+@SECREF@ monitor-prop
+
+## Device properties
+
+@SECREF@ device-prop
+
+## Node properties
+
+@SECREF@ node-prop
+
+## Port properties
+
+@SECREF@ port-prop
+
+## Client properties
+
+@SECREF@ client-prop
+
 # AUTHORS
 
 The PipeWire Developers <$(PACKAGE_BUGREPORT)>;
diff --git a/doc/dox/config/xref.md b/doc/dox/config/xref.md
new file mode 100644
index 000000000..e5652fd85
--- /dev/null
+++ b/doc/dox/config/xref.md
@@ -0,0 +1,51 @@
+\page page_config_xref Index
+
+\ref page_man_pipewire_conf_5 "pipewire.conf"
+
+@SECREF@ pipewire.conf
+
+\ref page_man_pipewire-pulse_conf_5 "pipewire-pulse.conf"
+
+@SECREF@ pipewire-pulse.conf
+
+\ref page_man_pipewire-client_conf_5 "client.conf, client-rt.conf"
+
+@SECREF@ client.conf
+
+\ref page_man_pipewire-jack_conf_5 "jack.conf"
+
+@SECREF@ jack.conf
+
+**Runtime settings**
+
+@SECREF@ pipewire-settings
+
+**Environment variables**
+
+@SECREF@ pipewire-env client-env jack-env pulse-env
+
+**Object properties**
+
+@SECREF@ props
+
+**Monitor properties**
+
+@SECREF@ monitor-prop
+
+**Device properties**
+
+@SECREF@ device-prop
+
+**Node properties**
+
+@SECREF@ node-prop
+
+**Port properties**
+
+@SECREF@ port-prop
+
+**Client properties**
+
+@SECREF@ client-prop
+
+\see pw_keys in API documentation.
diff --git a/doc/meson.build b/doc/meson.build
index a10e35c99..5f2e28fb8 100644
--- a/doc/meson.build
+++ b/doc/meson.build
@@ -54,6 +54,7 @@ extra_docs = [
   'dox/pulse-modules.dox',
   'dox/programs/index.md',
   'dox/config/index.md',
+  'dox/config/xref.md',
   'dox/internals/index.dox',
   'dox/internals/design.dox',
   'dox/internals/access.dox',