mirror of
https://github.com/mpv-player/mpv
synced 2025-04-11 04:01:31 +00:00
DOCS: document the new way to handle interface changes
Manually editing interface-changes.rst is a giant maintenance pain that causes merge conflicts all the time. Stop doing that nonsense and instead have changes be written to files in DOCS/interface-changes. Also remove that one sentence in changes.rst because it's just not true.
This commit is contained in:
parent
8c1117b2cb
commit
58363d209c
@ -131,12 +131,24 @@ Touching user-visible parts may require updating the mpv docs
|
|||||||
- Changes to command line options (addition/modification/removal) must be
|
- Changes to command line options (addition/modification/removal) must be
|
||||||
documented in options.rst.
|
documented in options.rst.
|
||||||
- Changes to input properties or input commands must be documented in input.rst.
|
- Changes to input properties or input commands must be documented in input.rst.
|
||||||
- All incompatible changes to the user interface (options, properties, commands)
|
|
||||||
must be documented with a small note in interface-changes.rst. (Additions may
|
|
||||||
be documented there as well, but this isn't required.)
|
|
||||||
- Changes to the libmpv API must be reflected in the libmpv's headers doxygen,
|
- Changes to the libmpv API must be reflected in the libmpv's headers doxygen,
|
||||||
and in client-api-changes.rst.
|
and in client-api-changes.rst.
|
||||||
|
|
||||||
|
Interface change policy
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
- All incompatible changes to the user interface (options, properties, commands)
|
||||||
|
must be documented by making a new text file with a txt extension containing a
|
||||||
|
small note in the DOCS/interface-changes directory.
|
||||||
|
- The name of the file should be brief and related to the commit that makes the
|
||||||
|
change.
|
||||||
|
- Grouping multiple related changes in the same file is also OK. Just be sure to
|
||||||
|
put each separate change on a different line.
|
||||||
|
- Documenting additions in DOCS/interface-changes is optional but encouraged.
|
||||||
|
- interface-changes.rst is never directly updated except when making new major
|
||||||
|
releases.
|
||||||
|
- See DOCS/interface-changes/example.txt for an example.
|
||||||
|
|
||||||
Code formatting
|
Code formatting
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
|
@ -17,9 +17,12 @@ a large part of the user interface and APIs.
|
|||||||
|
|
||||||
Also see compatibility.rst.
|
Also see compatibility.rst.
|
||||||
|
|
||||||
This document lists changes to them. New changes are added to the top. Usually,
|
This document lists changes to them. New options/commands/etc. are not always
|
||||||
only incompatible or important changes are mentioned. New options/commands/etc.
|
listed.
|
||||||
are not always listed.
|
|
||||||
|
**Never** write to this file directly except when making releases. New changes
|
||||||
|
are added in the interface-changes directory instead. See contribute.md for more
|
||||||
|
details.
|
||||||
|
|
||||||
Interface changes
|
Interface changes
|
||||||
=================
|
=================
|
||||||
|
1
DOCS/interface-changes/example.txt
Normal file
1
DOCS/interface-changes/example.txt
Normal file
@ -0,0 +1 @@
|
|||||||
|
deprecate `--foo`, instead use `--bar=foo` as a replacement
|
@ -10,8 +10,7 @@ There is no real changelog, but you can look at the following things:
|
|||||||
* The git log, which is the "real" changelog
|
* The git log, which is the "real" changelog
|
||||||
* The file https://github.com/mpv-player/mpv/blob/master/DOCS/interface-changes.rst
|
* The file https://github.com/mpv-player/mpv/blob/master/DOCS/interface-changes.rst
|
||||||
documents changes to the command and user interface, such as options and
|
documents changes to the command and user interface, such as options and
|
||||||
properties. (It usually documents breaking changes only, additions and
|
properties.
|
||||||
enhancements are often not listed.)
|
|
||||||
* C API changes are listed in
|
* C API changes are listed in
|
||||||
https://github.com/mpv-player/mpv/blob/master/DOCS/client-api-changes.rst
|
https://github.com/mpv-player/mpv/blob/master/DOCS/client-api-changes.rst
|
||||||
* The file ``mplayer-changes.rst`` in the ``DOCS`` sub directory on the git
|
* The file ``mplayer-changes.rst`` in the ``DOCS`` sub directory on the git
|
||||||
|
@ -26,8 +26,13 @@ While on master:
|
|||||||
|
|
||||||
- Update the `VERSION` file.
|
- Update the `VERSION` file.
|
||||||
|
|
||||||
- Update `DOCS/client-api-changes.rst` and `DOCS/interface-changes.rst`
|
- Update `DOCS/client-api-changes.rst` (in particular, update the last version
|
||||||
(in particular, update the last version numbers if necessary)
|
number if necessary)
|
||||||
|
|
||||||
|
- Run `TOOLS/gen-interface-changes.py` to refresh `DOCS/interface-changes.rst`,
|
||||||
|
edit manually as necessary.
|
||||||
|
|
||||||
|
- Delete all `.txt` files in the `DOCS/interface-changes` directory except for `example.txt`.
|
||||||
|
|
||||||
- Create signed commit with changes.
|
- Create signed commit with changes.
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user