Skip to content

Commit 840affc

Browse files
committed
Merge branch 'la/doc-choose-starting-point-fixup'
Clarify how to pick a starting point for a new topic in the SubmittingPatches document. * la/doc-choose-starting-point-fixup: SubmittingPatches: use of older maintenance tracks is an exception SubmittingPatches: explain why 'next' and above are inappropriate base SubmittingPatches: choice of base for fixing an older maintenance track
2 parents a53e8a6 + 369998d commit 840affc

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

Documentation/SubmittingPatches

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,28 @@ latest HEAD commit of `maint` or `master` based on the following cases:
5050

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

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+
5365
This also means that `next` or `seen` are inappropriate starting points
5466
for your work, if you want your work to have a realistic chance of
55-
graduating to `master`. They are simply not designed to provide a
56-
stable base for new work, because they are (by design) frequently
57-
re-integrated with incoming patches on the mailing list and force-pushed
58-
to replace previous versions of these branches.
67+
graduating to `master`. They are simply not designed to be used as a
68+
base for new work; they are only there to make sure that topics in
69+
flight work well together. This is why both `next` and `seen` are
70+
frequently re-integrated with incoming patches on the mailing list and
71+
force-pushed to replace previous versions of themselves. A topic that is
72+
literally built on top of `next` cannot be merged to `master` without
73+
dragging in all the other topics in `next`, some of which may not be
74+
ready.
5975

6076
For example, if you are making tree-wide changes, while somebody else is
6177
also making their own tree-wide changes, your work may have severe

0 commit comments

Comments
 (0)