| Message ID | xmqq351bfdtj.fsf_-_@gitster.g (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | SubmittingPatches: clarify which branch to use | expand |
Thank you for breaking out these patches (in the future I will try to do it on my end to save you the trouble). I just have small wording nits (see below), but otherwise LGTM. Thanks again. Junio C Hamano <gitster@pobox.com> writes: > diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches > index 559c02c90c..0d1b53d4e5 100644 > --- a/Documentation/SubmittingPatches > +++ b/Documentation/SubmittingPatches > @@ -46,15 +46,22 @@ latest HEAD commit of `maint` or `master` based on the following cases: > * If you are fixing bugs in the released version, use `maint` as the > starting point (which may mean you have to fix things without using > new API features on the cutting edge that recently appeared in > - `master` but were not available in the released version). If the bug > - exists in an older version (e.g., commit `X` introduced the bug, and > - `git describe --containx X` says `v2.30.0-rc2-gXXXXXX` has it), then > - use the tip of the maintenance branch for the 2.30.x versions in the > - `maint-2.30` branch in https://github.com/gitster/git[the maintainer's > - repo]. > + `master` but were not available in the released version). > > * Otherwise (such as if you are adding new features) use `master`. > > + > +NOTE: In an exceptional case, a bug that was introduced in an old I think "In exceptional cases" reads more naturally. > +version may have to be fixed for users of releases that are much older > +than the recent releases. `git describe --contains X` may describe > +`X` as `v2.30.0-rc2-gXXXXXX` for the commit `X` that introduced the > +bug, and the bug may be so high-impact that we may need to issue a new > +maintenance release for Git 2.30.x series, when "Git 2.41.0" is the > +current release. In such a case, you may want to use the tip of the > +maintenance branch for the 2.30.x series, which may be available as s/as/in the > +`maint-2.30` branch in https://github.com/gitster/git[the maintainer's > +"broken out" repo]. > + > This also means that `next` or `seen` are inappropriate starting points > for your work, if you want your work to have a realistic chance of > graduating to `master`. They are simply not designed to be used as a > -- > 2.41.0-450-ga80be15292
Linus Arver <linusa@google.com> writes:
> I just have small wording nits (see below), but otherwise LGTM.
Thanks. Rolled typo/format fixes in.
1: e3386ce69d ! 1: f835de52d7 SubmittingPatches: explain why 'next' and above are inappropriate base
@@ Documentation/SubmittingPatches: latest HEAD commit of `maint` or `master` based
+flight work well together. This is why both `next` and `seen` are
+frequently re-integrated with incoming patches on the mailing list and
+force-pushed to replace previous versions of themselves. A topic that is
-+literally built on top of `next` cannot be merged to 'master' without
++literally built on top of `next` cannot be merged to `master` without
+dragging in all the other topics in `next`, some of which may not be
+ready.
2: 6b2650d32f ! 2: 369998df83 SubmittingPatches: use of older maintenance tracks is an exception
@@ Documentation/SubmittingPatches: latest HEAD commit of `maint` or `master` based
* Otherwise (such as if you are adding new features) use `master`.
+
-+NOTE: In an exceptional case, a bug that was introduced in an old
++NOTE: In exceptional cases, a bug that was introduced in an old
+version may have to be fixed for users of releases that are much older
+than the recent releases. `git describe --contains X` may describe
+`X` as `v2.30.0-rc2-gXXXXXX` for the commit `X` that introduced the
+bug, and the bug may be so high-impact that we may need to issue a new
+maintenance release for Git 2.30.x series, when "Git 2.41.0" is the
+current release. In such a case, you may want to use the tip of the
-+maintenance branch for the 2.30.x series, which may be available as
++maintenance branch for the 2.30.x series, which may be available in the
+`maint-2.30` branch in https://github.com/gitster/git[the maintainer's
+"broken out" repo].
+
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches index 559c02c90c..0d1b53d4e5 100644 --- a/Documentation/SubmittingPatches +++ b/Documentation/SubmittingPatches @@ -46,15 +46,22 @@ latest HEAD commit of `maint` or `master` based on the following cases: * If you are fixing bugs in the released version, use `maint` as the starting point (which may mean you have to fix things without using new API features on the cutting edge that recently appeared in - `master` but were not available in the released version). If the bug - exists in an older version (e.g., commit `X` introduced the bug, and - `git describe --containx X` says `v2.30.0-rc2-gXXXXXX` has it), then - use the tip of the maintenance branch for the 2.30.x versions in the - `maint-2.30` branch in https://github.com/gitster/git[the maintainer's - repo]. + `master` but were not available in the released version). * Otherwise (such as if you are adding new features) use `master`. + +NOTE: In an exceptional case, a bug that was introduced in an old +version may have to be fixed for users of releases that are much older +than the recent releases. `git describe --contains X` may describe +`X` as `v2.30.0-rc2-gXXXXXX` for the commit `X` that introduced the +bug, and the bug may be so high-impact that we may need to issue a new +maintenance release for Git 2.30.x series, when "Git 2.41.0" is the +current release. In such a case, you may want to use the tip of the +maintenance branch for the 2.30.x series, which may be available as +`maint-2.30` branch in https://github.com/gitster/git[the maintainer's +"broken out" repo]. + This also means that `next` or `seen` are inappropriate starting points for your work, if you want your work to have a realistic chance of graduating to `master`. They are simply not designed to be used as a
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 to just fix it in the current maintenance track, leaving the bug unfixed in the older maintenance tracks. Demote the "use older maintenance track" as a side note, and explain that the choice is used only in exceptional cases. Signed-off-by: Junio C Hamano <gitster@pobox.com> --- Documentation/SubmittingPatches | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-)