| Message ID | 203ed19dd1b72a8085af05359d5a226b94fe2c7f.1688778359.git.gitgitgadget@gmail.com (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | SubmittingPatches: clarify which branch to use | expand |
"Linus Arver via GitGitGadget" <gitgitgadget@gmail.com> writes: > From: Linus Arver <linusa@google.com> > > Signed-off-by: Linus Arver <linusa@google.com> > --- If you leave the body of the commit log message empty, can we at least have a bit more helpful title so that it is clear what we are being more explicit about? > [[base-branch]] > -=== Decide what to base your work on. > +=== Decide which branch to base your work on. Technically speaking, what the user needs to decide here is on top of what commit to base their work on. There may not be a suitable branch anywhere. But this series will be updating the section even more in the later steps, so let's read on. > @@ -317,8 +317,8 @@ Please make sure your patch does not add commented out debugging code, > or include any extra files which do not relate to what your patch > is trying to achieve. Make sure to review > your patch after generating it, to ensure accuracy. Before > -sending out, please make sure it cleanly applies to the base you > -have chosen in the "Decide what to base your work on" section, > +sending out, please make sure it cleanly applies to the branch you > +have chosen in the "Decide which branch to base your work on" section, > and unless it targets the `master` branch (which is the default), > mark your patches as such.
Junio C Hamano <gitster@pobox.com> writes: > "Linus Arver via GitGitGadget" <gitgitgadget@gmail.com> writes: > >> From: Linus Arver <linusa@google.com> >> >> Signed-off-by: Linus Arver <linusa@google.com> >> --- > > If you leave the body of the commit log message empty, can we > at least have a bit more helpful title so that it is clear what we > are being more explicit about? Certainly. Will update in v2. >> [[base-branch]] >> -=== Decide what to base your work on. >> +=== Decide which branch to base your work on. > > Technically speaking, what the user needs to decide here is on top > of what commit to base their work on. There may not be a suitable > branch anywhere. Good point. Will add this in v2. I think what threw me off originally was the internal section link name "[[base-branch]]". I think that could be reworded to "base-starting-point" or similar. > But this series will be updating the section even more in the later > steps, so let's read on. > > > >> @@ -317,8 +317,8 @@ Please make sure your patch does not add commented out debugging code, >> or include any extra files which do not relate to what your patch >> is trying to achieve. Make sure to review >> your patch after generating it, to ensure accuracy. Before >> -sending out, please make sure it cleanly applies to the base you >> -have chosen in the "Decide what to base your work on" section, >> +sending out, please make sure it cleanly applies to the branch you >> +have chosen in the "Decide which branch to base your work on" section, >> and unless it targets the `master` branch (which is the default), >> mark your patches as such.
Linus Arver <linusa@google.com> writes: > I think what threw me off originally was the internal section link name > "[[base-branch]]". I think that could be reworded to > "base-starting-point" or similar. Yeah, I agree that it is misleading to say "branch" as if it has to already exist. starting-point would be a good phrase to include, so I would imagine base-starting-point would be an appropriate name for the inline anchor.
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches index b89678cedc3..5611580fb4c 100644 --- a/Documentation/SubmittingPatches +++ b/Documentation/SubmittingPatches @@ -8,7 +8,7 @@ project. There is also a link:MyFirstContribution.html[step-by-step tutorial] available which covers many of these same guidelines. [[base-branch]] -=== Decide what to base your work on. +=== Decide which branch to base your work on. In general, always base your work on the oldest branch that your change is relevant to. @@ -317,8 +317,8 @@ Please make sure your patch does not add commented out debugging code, or include any extra files which do not relate to what your patch is trying to achieve. Make sure to review your patch after generating it, to ensure accuracy. Before -sending out, please make sure it cleanly applies to the base you -have chosen in the "Decide what to base your work on" section, +sending out, please make sure it cleanly applies to the branch you +have chosen in the "Decide which branch to base your work on" section, and unless it targets the `master` branch (which is the default), mark your patches as such.