Skip to content

Commit 369998d

Browse files
committed
SubmittingPatches: use of older maintenance tracks is an exception
While we could technically fix each and every bug on top of the commit that introduced it, it is not necessarily practical. For trivial and low-value bugfixes, it often is simpler and sufficient to just fix it in the current maintenance track, leaving the bug unfixed in the older maintenance tracks. Demote the "use older maintenance track to fix old bugs" as a side note, and explain that the choice is used only in exceptional cases. Signed-off-by: Junio C Hamano <[email protected]>
1 parent f835de5 commit 369998d

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

Documentation/SubmittingPatches

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,15 +46,22 @@ latest HEAD commit of `maint` or `master` based on the following cases:
4646
* If you are fixing bugs in the released version, use `maint` as the
4747
starting point (which may mean you have to fix things without using
4848
new API features on the cutting edge that recently appeared in
49-
`master` but were not available in the released version). If the bug
50-
exists in an older version (e.g., commit `X` introduced the bug, and
51-
`git describe --contains X` says `v2.30.0-rc2-gXXXXXX` has it), then
52-
use the tip of the maintenance branch for the 2.30.x versions in the
53-
`maint-2.30` branch in https://github.com/gitster/git[the maintainer's
54-
repo].
49+
`master` but were not available in the released version).
5550

5651
* Otherwise (such as if you are adding new features) use `master`.
5752

53+
54+
NOTE: In exceptional cases, a bug that was introduced in an old
55+
version may have to be fixed for users of releases that are much older
56+
than the recent releases. `git describe --contains X` may describe
57+
`X` as `v2.30.0-rc2-gXXXXXX` for the commit `X` that introduced the
58+
bug, and the bug may be so high-impact that we may need to issue a new
59+
maintenance release for Git 2.30.x series, when "Git 2.41.0" is the
60+
current release. In such a case, you may want to use the tip of the
61+
maintenance branch for the 2.30.x series, which may be available in the
62+
`maint-2.30` branch in https://github.com/gitster/git[the maintainer's
63+
"broken out" repo].
64+
5865
This also means that `next` or `seen` are inappropriate starting points
5966
for your work, if you want your work to have a realistic chance of
6067
graduating to `master`. They are simply not designed to be used as a

0 commit comments

Comments
 (0)