From 33598182a008170b0fea05f0d149acfefaf99d0c Mon Sep 17 00:00:00 2001 From: wm4 Date: Wed, 21 Sep 2016 12:45:27 +0200 Subject: manpage: lua: mention recent deprecations These are listed in interface-changes.rst, but the documentation in the manpage wasn't updated. --- DOCS/man/lua.rst | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) (limited to 'DOCS') diff --git a/DOCS/man/lua.rst b/DOCS/man/lua.rst index cb32baabc1..256f6bd9ed 100644 --- a/DOCS/man/lua.rst +++ b/DOCS/man/lua.rst @@ -412,6 +412,8 @@ These also live in the ``mp`` module, but are documented separately as they are useful only in special situations. ``mp.suspend()`` + This function has been deprecated in mpv 0.21.0 (no replacement). + Suspend the mpv main loop. There is a long-winded explanation of this in the C API function ``mpv_suspend()``. In short, this prevents the player from displaying the next video frame, so that you don't get blocked when @@ -420,11 +422,15 @@ are useful only in special situations. Before mpv 0.17.0, this was automatically called by the event handler. ``mp.resume()`` + This function has been deprecated in mpv 0.21.0 (no replacement). + Undo one ``mp.suspend()`` call. ``mp.suspend()`` increments an internal counter, and ``mp.resume()`` decrements it. When 0 is reached, the player is actually resumed. ``mp.resume_all()`` + This function has been deprecated in mpv 0.21.0 (no replacement). + This resets the internal suspend counter and resumes the player. (It's like calling ``mp.resume()`` until the player is actually resumed.) @@ -633,8 +639,6 @@ strictly part of the guaranteed API. Set to ``true`` if the process has been killed by mpv as a result of ``cancellable`` being set to ``true``. - In all cases, ``mp.resume_all()`` is implicitly called. - ``utils.subprocess_detached(t)`` Runs an external process and detaches it from mpv's control. @@ -646,8 +650,6 @@ strictly part of the guaranteed API. The function returns ``nil``. - In all cases, ``mp.resume_all()`` is implicitly called. - ``utils.parse_json(str [, trail])`` Parses the given string argument as JSON, and returns it as a Lua table. On error, returns ``nil, error``. (Currently, ``error`` is just a string -- cgit v1.2.3