Bug 107379 - Documentation for pulseaudio is missing modules
Summary: Documentation for pulseaudio is missing modules
Status: RESOLVED MOVED
Alias: None
Product: PulseAudio
Classification: Unclassified
Component: misc (show other bugs)
Version: unspecified
Hardware: Other All
: medium normal
Assignee: pulseaudio-bugs
QA Contact: pulseaudio-bugs
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2018-07-25 18:56 UTC by Brian "Redbeard" Harrington
Modified: 2018-07-30 10:29 UTC (History)
1 user (show)

See Also:
i915 platform:
i915 features:


Attachments

Description Brian "Redbeard" Harrington 2018-07-25 18:56:41 UTC
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
Comment 1 GitLab Migration User 2018-07-30 10:29:59 UTC
-- GitLab Migration Automatic Message --

This bug has been migrated to freedesktop.org's GitLab instance and has been closed from further activity.

You can subscribe and participate further through the new bug through this link to our GitLab instance: https://gitlab.freedesktop.org/pulseaudio/pulseaudio/issues/465.


Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.