History

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.

nanahi committed 2 years ago

Commit eb38c3c1 parent c489f341 file · +9 −0Browse files

Unified · Split

DOCS/compatibility.rst+9−0
@@ -51,6 +51,15 @@ functionality still works, and a replacement is available (if technically · 50 unmodified lines
51reasonable). For example, a feature deprecated in mpv 0.30.0 may be removed in51reasonable). For example, a feature deprecated in mpv 0.30.0 may be removed in
52mpv 0.32.0. Minor releases do not count towards this.52mpv 0.32.0. Minor releases do not count towards this.
53 53
54Under extraordinary circumstances, such as missed incompatible changes that are
55already included in a release, critical security fixes, or a severe shortage of
56developer time to address the known incompatible changes, important/often used
57parts may be broken immediately, but the change must be extensively documented:
58all of the related documentations (including manpage, interface-changes.rst,
59etc., retrospectively modified if applicable) must clearly state the following:
60the fact that the change is a breaking change; the version when the breaking
61change happened; and the reason, impact, and suggested remedy actions.
62
54Less useful parts can be broken immediately, but must come with some sort of63Less useful parts can be broken immediately, but must come with some sort of
55removal warning.64removal warning.
56 65

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t