Bug 107379

The documentation generated for PulseAudio modules (https://cgit.freedesktop.org/wiki/www/log/Software/PulseAudio/Documentation/User/Modules.mdwn) is presently missing a number of long standing modules from the page.  

This was discovered after attempting to find user documentation for the module "module-virtual-source" (https://cgit.freedesktop.org/pulseaudio/pulseaudio/tree/src/modules/module-virtual-source.c).  

A cursory examination includes the following as possible candidates for missing documentation:

module-always-source
module-augment-properties
module-cli-protocol-tcp
module-cli-protocol-unix
module-combine
module-dbus-protocol
module-esound-protocol-unix
module-hal-detect
module-native-protocol-unix
module-simple-protocol-tcp
module-simple-protocol-unix
module-switch-on-port-available
module-tunnel-source
module-virtual-sink
module-virtual-source


Some of these appear to be "plumbing" as opposed to "porcelain", regardless when folks begin trying to manipulate modules directly it could be argued that it's all plumbing.

FYI, while this requires a few on distro tools (e.g. elinks, rpm, etc) this is how the list was generated for spot checking and validation:

# Command to list differences in modules:

diff -wyr <(links --dump https://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/Modules/ | grep "^  module-" | sort ) <(ls -1 /usr/lib64/pulse-12.0/modules/module-*| awk -F\/ '{print $NF}' | sed 's/\.so//g')

This allowed for isolating out only modules which were on the local system by then searching for ">".

Subsequently, all resulting output could then be cross-referenced against the distro's package manager (in this case, RPM in Fedora 28) to isolate which modules were coming from the core pulseaudio package:


diff -wyr <(links --dump https://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/Modules/ | grep "^  module-" | sort ) <(ls -1 /usr/lib64/pulse-12.0/modules/module-*| awk -F\/ '{print $NF}' | sed 's/\.so//g')  | awk '/>/ {print "/usr/lib64/pulse-12.0/modules/" $NF ".so"}' | xargs -n1 rpm -qf