diff options
author | Dudemanguy <random342@airmail.cc> | 2024-02-28 10:24:09 -0600 |
---|---|---|
committer | Dudemanguy <random342@airmail.cc> | 2024-03-20 22:38:56 +0000 |
commit | 58363d209c2bb24c6265adfb6efa81c716bf8db7 (patch) | |
tree | 6b0967ee06c4e8fe8c677fe7e64993867c978a57 /DOCS/release-policy.md | |
parent | 8c1117b2cb0f5f01e1ca045e7ba426e2e9c4771e (diff) | |
download | mpv-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/release-policy.md')
-rw-r--r-- | DOCS/release-policy.md | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/DOCS/release-policy.md b/DOCS/release-policy.md index 2426ab4e7c..23bc48befd 100644 --- a/DOCS/release-policy.md +++ b/DOCS/release-policy.md @@ -26,8 +26,13 @@ While on master: - Update the `VERSION` file. -- Update `DOCS/client-api-changes.rst` and `DOCS/interface-changes.rst` - (in particular, update the last version numbers if necessary) +- Update `DOCS/client-api-changes.rst` (in particular, update the last version + 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. |