From 58363d209c2bb24c6265adfb6efa81c716bf8db7 Mon Sep 17 00:00:00 2001 From: Dudemanguy Date: Wed, 28 Feb 2024 10:24:09 -0600 Subject: 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. --- DOCS/release-policy.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) (limited to 'DOCS/release-policy.md') 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. -- cgit v1.2.3