mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-01 22:58:50 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

man: move from xmltoman to rst2man

Browse source 
xmltoman looks dead and uses XML as well as pulls in a long list of
Perl dependencies. This replaces it with rst2man that has almost no
dependencies beyond Python, which is already required for the Meson
build system.

Naturally rst2man uses reStructuredText and the pages were rewritten
via regex and manual editing to be as close to original XML format
as possible. A few fixes and updates were done too. Most notably a
note was added to indicate that production deployments should not be
starting the session manager via pipewire.conf file.

There's three slight formatting issues/differences:
1. rst2man produces simpler footer.
2. "-f | --foo=value" confuses the parser and it fails to correctly
   add argument specific syntax highlighting to assignment value.
3. XML version had inconsistent use of <arg> and <opt> which has
   been partially addressed. But different manual pages still have
   their differences to what and how is highlighted.
This commit is contained in:
Niklāvs Koļesņikovs 2021-09-03 10:16:48 +03:00 • committed by Wim Taymans
parent 91f1b44499
commit e41187d643
23 changed files with 813 additions and 912 deletions
Download patch file Download diff file Expand all files Collapse all files

8
.gitlab-ci.yml
View file

@ -22,7 +22,7 @@ include:
.fedora:
variables:
# Update this tag when you want to trigger a rebuild
FDO_DISTRIBUTION_TAG: '2021-08-01.0'
FDO_DISTRIBUTION_TAG: '2021-09-03.0'
FDO_DISTRIBUTION_VERSION: '33'
FDO_DISTRIBUTION_PACKAGES: >-
alsa-lib-devel
@ -42,6 +42,7 @@ include:
libva-devel
libX11-devel
pulseaudio-libs-devel
python3-docutils
sbc-devel
ShellCheck
SDL2-devel
@ -50,7 +51,6 @@ include:
webrtc-audio-processing-devel
which
valgrind
xmltoman
ninja-build
pkgconf
python3-pip
@ -60,7 +60,7 @@ include:
.ubuntu:
variables:
# Update this tag when you want to trigger a rebuild
FDO_DISTRIBUTION_TAG: '2021-08-01.0'
FDO_DISTRIBUTION_TAG: '2021-09-03.0'
FDO_DISTRIBUTION_VERSION: '20.04'
FDO_DISTRIBUTION_PACKAGES: >-
debhelper-compat
@ -82,8 +82,8 @@ include:
libx11-dev
ninja-build
pkg-config
python3-docutils
systemd
xmltoman
python3-pip
FDO_DISTRIBUTION_EXEC: >-
pip3 install meson