From d890f369dff5609e3619e5120c433b952803082d Mon Sep 17 00:00:00 2001 From: nanahi <130121847+na-na-hi@users.noreply.github.com> Date: Thu, 16 May 2024 02:28:31 -0400 Subject: [PATCH] DOCS/man: note that default autoprobe order is unrealiable The default values for --ao, --vo, --gpu-api, --gpu-context change from time to time, but some libmpv clients rely on the existing autoprobe order and breaks as a result when the value changes. This specifies that the default autoprobe order should not be relied upon. --- DOCS/man/ao.rst | 4 ++++ DOCS/man/options.rst | 7 ++++++- DOCS/man/vo.rst | 4 ++++ 3 files changed, 14 insertions(+), 1 deletion(-) diff --git a/DOCS/man/ao.rst b/DOCS/man/ao.rst index 78dfed3b51..f03f64242e 100644 --- a/DOCS/man/ao.rst +++ b/DOCS/man/ao.rst @@ -15,6 +15,10 @@ in the list. See ``--ao=help`` for a list of compiled-in audio output drivers sorted by autoprobe order. + Note that the default audio output driver is subject to change, and must + not be relied upon. If a certain AO needs to be used, it must be + explicitly specified. + Available audio output drivers are: ``alsa`` diff --git a/DOCS/man/options.rst b/DOCS/man/options.rst index 8ef6a65a0e..4dd3bbb47a 100644 --- a/DOCS/man/options.rst +++ b/DOCS/man/options.rst @@ -6447,6 +6447,9 @@ them. order. You can also pass ``help`` to get a complete list of compiled in backends (sorted by the default autoprobe order). + Note that the default GPU context is subject to change, and must not be relied upon. + If a certain GPU context needs to be used, it must be explicitly specified. + auto auto-select (default). Note that this context must be used alone and does not participate in the priority list. @@ -6489,7 +6492,9 @@ them. Controls which type of graphics APIs will be accepted: auto - Use any available API (default) + Use any available API (default). Note that the default GPU API used for this + value is subject to change, and must not be relied upon. If a certain GPU API + needs to be used, it must be explicitly specified. opengl Allow only OpenGL (requires OpenGL 2.1+ or GLES 2.0+) vulkan diff --git a/DOCS/man/vo.rst b/DOCS/man/vo.rst index 41fcb71a1b..d259cad907 100644 --- a/DOCS/man/vo.rst +++ b/DOCS/man/vo.rst @@ -19,6 +19,10 @@ in the list. does not work, it will fallback to other drivers (in the same order as listed by ``--vo=help``). + Note that the default video output driver is subject to change, and must + not be relied upon. If a certain VO needs to be used (e.g. for ``libmpv`` + rendering API), it must be explicitly specified. + Available video output drivers are: ``gpu``