Mirrors/mpv
1
0
Fork 0
mirror of https://github.com/mpv-player/mpv.git synced 2025-12-26 21:00:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

DOCS: add a changelog for option/command/property changes

Browse Source 
All these make up both user interface and API. It's a good idea to
actually keep track of changes to it.
This commit is contained in:
wm4
2015-05-22 19:00:13 +02:00
parent a165a61415
commit 17b3cab983
2 changed files with 47 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
DOCS/client-api-changes.rst
View File

@@ -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
===========