summaryrefslogtreecommitdiffstats
path: root/DOCS/interface-changes.rst
diff options
context:
space:
mode:
authorDudemanguy <random342@airmail.cc>2024-02-28 10:24:09 -0600
committerDudemanguy <random342@airmail.cc>2024-03-20 22:38:56 +0000
commit58363d209c2bb24c6265adfb6efa81c716bf8db7 (patch)
tree6b0967ee06c4e8fe8c677fe7e64993867c978a57 /DOCS/interface-changes.rst
parent8c1117b2cb0f5f01e1ca045e7ba426e2e9c4771e (diff)
downloadmpv-58363d209c2bb24c6265adfb6efa81c716bf8db7.tar.bz2
mpv-58363d209c2bb24c6265adfb6efa81c716bf8db7.tar.xz
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.
Diffstat (limited to 'DOCS/interface-changes.rst')
-rw-r--r--DOCS/interface-changes.rst9
1 files changed, 6 insertions, 3 deletions
diff --git a/DOCS/interface-changes.rst b/DOCS/interface-changes.rst
index b80e3635b1..5371fd43fe 100644
--- a/DOCS/interface-changes.rst
+++ b/DOCS/interface-changes.rst
@@ -17,9 +17,12 @@ a large part of the user interface and APIs.
Also see compatibility.rst.
-This document lists changes to them. New changes are added to the top. Usually,
-only incompatible or important changes are mentioned. New options/commands/etc.
-are not always listed.
+This document lists changes to them. New options/commands/etc. 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
=================