From eb38c3cb87654922597872b84bd04536b954ed5b Mon Sep 17 00:00:00 2001 From: nanahi <130121847+na-na-hi@users.noreply.github.com> Date: Thu, 16 May 2024 01:58:23 -0400 Subject: [PATCH] DOCS/compatibility.rst: add provision for dealing with severe breakages Currently there is no policy on what should be done when an immediate, severe breakage happens for "important/often used parts", which can cause serious concerns especially if such changes remain obscured. This adds a provision for this kind of incompatible changes under "extraordinary circumstances", which allows for the breaking change to happen if there is a critical reason to do so. Such changes must be extensively documented, and should be avoided as much as possible. --- DOCS/compatibility.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/DOCS/compatibility.rst b/DOCS/compatibility.rst index 5ecec7f025..fb54a19aec 100644 --- a/DOCS/compatibility.rst +++ b/DOCS/compatibility.rst @@ -51,6 +51,15 @@ functionality still works, and a replacement is available (if technically reasonable). For example, a feature deprecated in mpv 0.30.0 may be removed in mpv 0.32.0. Minor releases do not count towards this. +Under extraordinary circumstances, such as missed incompatible changes that are +already included in a release, critical security fixes, or a severe shortage of +developer time to address the known incompatible changes, important/often used +parts may be broken immediately, but the change must be extensively documented: +all of the related documentations (including manpage, interface-changes.rst, +etc., retrospectively modified if applicable) must clearly state the following: +the fact that the change is a breaking change; the version when the breaking +change happened; and the reason, impact, and suggested remedy actions. + Less useful parts can be broken immediately, but must come with some sort of removal warning.