colin/wireplumber
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: convert NEWS to rst and add it in the generated docs

Browse Source
This commit is contained in:
George Kiagiadakis
2021-05-26 09:30:06 +03:00
parent 87403eb1d4
commit 8b340a5705
5 changed files with 58 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

79
NEWS.md → NEWS.rst
View File

@@ -1,10 +1,12 @@
# WirePlumber 0.3.95
WirePlumber 0.3.95
~~~~~~~~~~~~~~~~~~
First pre-release (RC1) of WirePlumber 0.4.0.
Highlights:
- Lua scripting engine. All the session management logic is now scripted
and there is also the ability to run scripts standalone with `wpexec`
and there is also the ability to run scripts standalone with ``wpexec``
(see tests/examples).
- Compatibility with the latest PipeWire (0.3.26+ required). Also, most
@@ -29,11 +31,16 @@ Highlights:
wireplumber. Templated unit files are also available, which allow running
multiple instances of wireplumber with a specific configuration each.
# WirePlumber 0.3.0
Past releases
~~~~~~~~~~~~~
WirePlumber 0.3.0
.................
The desktop-ready release!
Changes since 0.2.96:
- Changed how the device endpoints & nodes are named
to make them look better in JACK graph tools, such as qjackctl.
JACK tools use the ':' character as a separator to distinguish the node
@@ -51,12 +58,14 @@ Changes since 0.2.96:
to use these PipeWire versions with WirePlumber without disabling streams
on audio sinks.
# WirePlumber 0.2.96
WirePlumber 0.2.96
..................
Second pre-release (RC2) of WirePlumber 0.3.0
Changes since 0.2.95:
- Quite some work went into fixing bugs related to the `ReserveDevice1`
- Quite some work went into fixing bugs related to the ``ReserveDevice1``
D-Bus API. It is now possible to start a JACK server before or after
WirePlumber and WirePlumber will automatically stop using the device that
JACK opens, while at the same time it will enable the special "JACK device"
@@ -66,33 +75,33 @@ Changes since 0.2.95:
bluez5 device with WirePlumber. Now it is possible to at least use the
A2DP sink (output to bluetooth speakers) without major issues
- On the API level, `WpCore` was changed to allow having multiple instances
that share the same `pw_context`. This is useful to have multiple
- On the API level, ``WpCore`` was changed to allow having multiple instances
that share the same ``pw_context``. This is useful to have multiple
connections to PipeWire, while sharing the context infrastructure
- `WpCore` also gained support for retrieving server info & properties
and `wpctl status` now also prints info about the server & all clients
- ``WpCore`` also gained support for retrieving server info & properties
and ``wpctl status`` now also prints info about the server & all clients
- `module-monitor` was modified to allow loading multiple monitor instances
- ``module-monitor`` was modified to allow loading multiple monitor instances
with one instance of the module itself
- Audio nodes are now configured with the sample rate that is defined
globally in `pipewire.conf` with `set-prop default.clock.rate <rate>`
globally in ``pipewire.conf`` with ``set-prop default.clock.rate <rate>``
- Policy now respects the `node.autoconnect` property; additionally, it is
now possible to specify endpoint ids in the `node.target` property of nodes
(so endpoint ids are accepted in the `PIPEWIRE_NODE` environment variable,
and in the `path` property of the pipewire gstreamer elements)
- Policy now respects the ``node.autoconnect`` property; additionally, it is
now possible to specify endpoint ids in the ``node.target`` property of nodes
(so endpoint ids are accepted in the ``PIPEWIRE_NODE`` environment variable,
and in the ``path`` property of the pipewire gstreamer elements)
- Fixed an issue where links between the si-convert audioconvert nodes and
the actual device nodes would stay active forever; they are now declared
as "passive" links, which allows the nodes to suspend. This requires
changes to PipeWire that were commited after 0.3.6; when using WirePlumber
with 0.3.5 or 0.3.6, it is recommended to disable streams on audio sinks
by commenting out the `streams = "audio-sink.streams"` lines in the
by commenting out the ``streams = "audio-sink.streams"`` lines in the
.endpoint configuration files
- `wireplumber.conf` now accepts comments to be present inside blocks and
- ``wireplumber.conf`` now accepts comments to be present inside blocks and
at the end of valid configuration lines
- Improved documentation and restructured the default configuration to be
@@ -101,28 +110,38 @@ Changes since 0.2.95:
- Fixed issues that prevented using WirePlumber with GLib < 2.60;
2.58 is now the actual minimum requirement
# WirePlumber 0.2.95
WirePlumber 0.2.95
..................
First pre-release of WirePlumber 0.3.0.
This is the first release that targets desktop use-cases. It aims to be
fully compatible with `pipewire-media-session`, while at the same time it
adds a couple of features that `pipewire-media-session` lacks, such as:
fully compatible with ``pipewire-media-session``, while at the same time it
adds a couple of features that ``pipewire-media-session`` lacks, such as:
- It makes use of session, endpoint and endpoint-stream objects
to orchestrate the graph
- It is configurable:
- It supports configuration of endpoints, so that their properties
(such as their name) can be overriden
- It also supports declaring priorities on endpoints, so that there
are sane defaults on the first start
- It supports partial configuration of linking policy
- It supports creating static node and device objects at startup,
also driven by configuration files
- It has the concept of session default endpoints, which can be changed
with `wpctl` and are stored in XDG_CONFIG_DIR, so the user may change
with ``wpctl`` and are stored in XDG_CONFIG_DIR, so the user may change
at runtime the target device of new links in a persistent way
- It supports volume & mute controls on audio endpoints, which can be
set with `wpctl`
set with ``wpctl``
- Last but not least, it is extensible
Also note that this release currently breaks compatibility with AGL, since
@@ -131,22 +150,22 @@ use-cases, and has been focusing on desktop support ever since.
Policy features specific to AGL and other embedded systems are expected
to come back in a 0.3.x point release.
# WirePlumber 0.2.0
WirePlumber 0.2.0
.................
As shipped in AGL Itchy Icefish 9.0.0 and Happy Halibut 8.0.5
# WirePlumber 0.1.1
WirePlumber 0.1.1
.................
As shipped in AGL Happy Halibut 8.0.2
# WirePlumber 0.1.1
WirePlumber 0.1.1
.................
As shipped in AGL Happy Halibut 8.0.1
# WirePlumber 0.1.0
WirePlumber 0.1.0
.................
First release of WirePlumber, as shipped in AGL Happy Halibut 8.0.0

1
docs/meson.build
View File

@@ -55,6 +55,7 @@ if build_doc
sphinx_files = files(
'_static'/'custom.css',
meson.source_root()/'README.rst',
meson.source_root()/'NEWS.rst',
)
subdir('rst')

1
docs/rst/index.rst
View File

@@ -26,3 +26,4 @@ Table of Contents
contributing.rst
community.rst
testing.rst
releases.rst

1
docs/rst/meson.build
View File

@@ -8,6 +8,7 @@ sphinx_files += files(
'contributing.rst',
'community.rst',
'testing.rst',
'releases.rst',
'c_api.rst',
'lua_api.rst',
)

6
docs/rst/releases.rst Normal file
View File

@@ -0,0 +1,6 @@
.. _releases:
Releases
========
.. include:: ../../NEWS.rst