From 4333854293119241991d39c6f5997e084532fa0a Mon Sep 17 00:00:00 2001
From: jcorporation <mail@jcgames.de>
Date: Tue, 20 Sep 2022 20:32:32 +0200
Subject: [PATCH] Add documentation for consume oneshot mode
---
doc/protocol.rst | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/doc/protocol.rst b/doc/protocol.rst
index 2b55aa124..a78f77840 100644
--- a/doc/protocol.rst
+++ b/doc/protocol.rst
@@ -470,7 +470,7 @@ Querying :program:`MPD`'s status
- ``repeat``: ``0`` or ``1``
- ``random``: ``0`` or ``1``
- ``single`` [#since_0_15]_: ``0``, ``1``, or ``oneshot`` [#since_0_21]_
- - ``consume`` [#since_0_15]_: ``0`` or ``1``
+ - ``consume`` [#since_0_15]_: ``0``, ``1`` or ``oneshot`` [#since_0_24]_
- ``playlist``: 31-bit unsigned integer, the playlist version number
- ``playlistlength``: integer, the length of the playlist
- ``state``: ``play``, ``stop``, or ``pause``
@@ -518,7 +518,7 @@ Playback options
:command:`consume {STATE}` [#since_0_15]_
Sets consume state to ``STATE``,
- ``STATE`` should be 0 or 1.
+ ``STATE`` should be ``0``, ``1`` or ``oneshot`` [#since_0_24]_.
When consume is activated, each song played is removed from playlist.
.. _command_crossfade:
@@ -1693,3 +1693,4 @@ client-to-client messages are local to the current partition.
.. [#since_0_23_3] Since :program:`MPD` 0.23.3
.. [#since_0_23_4] Since :program:`MPD` 0.23.4
.. [#since_0_23_5] Since :program:`MPD` 0.23.5
+.. [#since_0_24] Since :program:`MPD` 0.24