From 17b3cab983e8d2d802d01e99602dcc741d417f89 Mon Sep 17 00:00:00 2001 From: wm4 Date: Fri, 22 May 2015 19:00:13 +0200 Subject: DOCS: add a changelog for option/command/property changes All these make up both user interface and API. It's a good idea to actually keep track of changes to it. --- DOCS/client-api-changes.rst | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) (limited to 'DOCS/client-api-changes.rst') diff --git a/DOCS/client-api-changes.rst b/DOCS/client-api-changes.rst index 6dc473caba..e821d077c7 100644 --- a/DOCS/client-api-changes.rst +++ b/DOCS/client-api-changes.rst @@ -4,9 +4,7 @@ Introduction This file lists all changes that can cause compatibility issues when using mpv through the client API (libmpv and ``client.h``). Since the client API interfaces to input handling (commands, properties) as well as command line -options, this list is interesting for other uses of mpv, such as the Lua -scripting interface, key bindings in ``input.rst``, or plain command line -usage. +options, you should also look at ``interface-changes.rst``. Normally, changes to the C API that are incompatible to previous iterations receive a major version bump (i.e. the first version number is increased), @@ -20,6 +18,15 @@ The version number is the same as used for MPV_CLIENT_API_VERSION (see Also, read the section ``Compatibility`` in ``client.h``. +Options, commands, properties +============================= + +Changes to these are not listed here, but in ``interface-changes.rst``. (Before +client API version 1.17, they were listed here partially.) + +This listing includes changes to the bare C API and behavior only, not what +you can access with them. + API changes =========== -- cgit v1.2.3