summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2020-03-05 11:01:07 +0100
committerwm4 <wm4@nowhere>2020-03-05 22:00:50 +0100
commite7de0e718c31778961d54655d26a9b49c776f9c8 (patch)
treed68df464caceb2eb15ac7f7c608d767caaf1cc54
parent3b8b7cb9d481828953f105f92bacc07a3cb2f332 (diff)
downloadmpv-e7de0e718c31778961d54655d26a9b49c776f9c8.tar.bz2
mpv-e7de0e718c31778961d54655d26a9b49c776f9c8.tar.xz
manpage: clarify writes to playlist-pos
I don't know what should happen when the same value is written to the property. It seems that it would be more natural if it were ignored (since that's also what is done with options now), but you could argue the other way around as well. In any case, changing it silently could leads to user scripts etc. breaking, so don't change it now. Instead, add blabla to the manpage to put the responsibility on the user, so when we suddenly change it one day, we can blame any breakages on someone else. See: #7501
-rw-r--r--DOCS/man/input.rst10
1 files changed, 8 insertions, 2 deletions
diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst
index 04cd8883f7..a6f77dff0a 100644
--- a/DOCS/man/input.rst
+++ b/DOCS/man/input.rst
@@ -2233,8 +2233,14 @@ Property list
is returned instead.
``playlist-pos`` (RW)
- Current position on playlist. The first entry is on position 0. Writing
- to the property will restart playback at the written entry.
+ Current position on playlist. The first entry is on position 0. Writing to
+ this property may start playback at the new position.
+
+ What happens if you write the same value back to the property is
+ implementation dependent. Currently, writing the same value will restart
+ playback from the beginning. It is possible (but not necessarily planned)
+ that in the future, write access if the same value is written will be
+ ignored.
``playlist-pos-1`` (RW)
Same as ``playlist-pos``, but 1-based.