Unified · Split
| @@ -1,7 +1,7 @@ | ||
| 1 | 1 | Release Policy |
| 2 | 2 | ============== |
| 3 | 3 | |
| 4 | −Once or twice a year, a new release is cut off of the master branch and is | |
| 4 | +Once or twice a year, a new release is cut off of the master branch and | |
| 5 | 5 | assigned a 0.X.Y version number, where X is incremented each time a release |
| 6 | 6 | contains breaking changes, such as changed options or added/removed features, |
| 7 | 7 | and Y is incremented if a release contains only bugfixes and other minor |
| @@ -61,58 +61,54 @@ Here is a template that can be used for writing the `RELEASE_NOTES` file: · 53 unmodified lines | ||
| 61 | 61 | Release 0.X.Y |
| 62 | 62 | ============= |
| 63 | 63 | |
| 64 | −This release requires FFmpeg <ver> or newer. | |
| 64 | +We are excited to announce the release of mpv 0.X.Y. | |
| 65 | 65 | |
| 66 | −Features | |
| 67 | −-------- | |
| 66 | +Key highlights: | |
| 68 | 67 | |
| 69 | −New | |
| 70 | −~~~ | |
| 68 | +* List of notable stuff | |
| 69 | + | |
| 70 | +This release requires FFmpeg <ver> or newer and libplacebo <ver> or newer. | |
| 71 | + | |
| 72 | +# Features | |
| 73 | + | |
| 74 | +## New | |
| 71 | 75 | |
| 72 | 76 | - List of new features |
| 73 | 77 | |
| 74 | 78 | |
| 75 | −Changed | |
| 76 | −~~~~~~~ | |
| 79 | +## Changed | |
| 77 | 80 | |
| 78 | 81 | - List of changed features |
| 79 | 82 | |
| 80 | 83 | |
| 81 | −Removed | |
| 82 | −~~~~~~~ | |
| 84 | +## Removed | |
| 83 | 85 | |
| 84 | 86 | - List of removed features |
| 85 | 87 | |
| 86 | 88 | |
| 87 | −Options and Commands | |
| 88 | −-------------------- | |
| 89 | +# Options and Commands | |
| 89 | 90 | |
| 90 | −Added | |
| 91 | −~~~~~ | |
| 91 | +## Added | |
| 92 | 92 | |
| 93 | 93 | - List of added options and commands |
| 94 | 94 | |
| 95 | 95 | |
| 96 | −Changed | |
| 97 | −~~~~~~~ | |
| 96 | +## Changed | |
| 98 | 97 | |
| 99 | 98 | - List of changed options and commands |
| 100 | 99 | |
| 101 | 100 | |
| 102 | −Deprecated | |
| 103 | −~~~~~~~~~~ | |
| 101 | +## Deprecated | |
| 104 | 102 | |
| 105 | 103 | - List of deprecated options and commands |
| 106 | 104 | |
| 107 | 105 | |
| 108 | −Removed | |
| 109 | −~~~~~~~ | |
| 106 | +## Removed | |
| 110 | 107 | |
| 111 | 108 | - List of removed options and commands |
| 112 | 109 | |
| 113 | 110 | |
| 114 | −Fixes and Minor Enhancements | |
| 115 | −---------------------------- | |
| 111 | +# Fixes and Minor Enhancements | |
| 116 | 112 | |
| 117 | 113 | - List of fixes and minor enhancements |
| 118 | 114 | |
| @@ -121,8 +117,9 @@ This listing is not complete. Check DOCS/client-api-changes.rst for a history · 2 unmodified lines | ||
| 121 | 117 | of changes to the client API, and DOCS/interface-changes.rst for a history |
| 122 | 118 | of changes to other user-visible interfaces. |
| 123 | 119 | |
| 124 | −A complete changelog can be seen by running `git log <start>..<end>` | |
| 125 | −in the git repository. | |
| 120 | +A complete changelog can be seen by running `git log start..end` | |
| 121 | +in the git repository or by visiting | |
| 122 | +<https://github.com/mpv-player/mpv/compare/start...end>. | |
| 126 | 123 | ``` |
| 127 | 124 | |
| 128 | 125 | When creating a new point release its changes should be added on top of the |
| @@ -131,7 +128,9 @@ the current 0.X branch will be included. This way the `RELEASE_NOTES` file · 2 unmodified lines | ||
| 131 | 128 | can be used by distributors as changelog for point releases too. |
| 132 | 129 | |
| 133 | 130 | The changelog of lists all changes since the last release, including those |
| 134 | −that have been backported to patch releases already. | |
| 131 | +that have been backported to patch releases already. Except for the | |
| 132 | +"Key highlights" section they are ordered chronologically with older commits | |
| 133 | +at the top. | |
| 135 | 134 | |
| 136 | 135 | Some additional advice: |
| 137 | 136 | - Especially for features, try to reword the messages so that the user-visible |