doc: clarify practices for submitting updated patch versions
PATCH 1/1 doc: clarify practices for submitting updated patch versions
The SubmittingPatches documentation briefly mentions that related patches should be grouped together in their own e-mail thread. Expand on this to explicitly state that updated versions of a patch series should also follow this. Also provide add a link to existing documentation from MyFirstContribution that provides detailed instructions on how to do this via git-send-email(1).
--- Documentation/SubmittingPatches | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-)
Documentation/SubmittingPatches +6 -4
@@ -415,10 +415,12 @@ e-mail tools, so that they may comment on specific portions of your code. For this reason, each patch should be submitted "inline" in a separate message. -Multiple related patches should be grouped into their own e-mail -thread to help readers find all parts of the series. To that end, -send them as replies to either an additional "cover letter" message -(see below), the first patch, or the respective preceding patch. +All subsequent versions of a patch series and other related patches should be +grouped into their own e-mail thread to help readers find all parts of the +series. To that end, send them as replies to either an additional "cover +letter" message (see below), the first patch, or the respective preceding patch. +Here is a link:MyFirstContribution.html#v2-git-send-email[step-by-step guide] on +how to submit updated versions of a patch series. If your log message (including your name on the `Signed-off-by` trailer) is not writable in ASCII, make sure that
base-commit: e326e520101dcf43a0499c3adc2df7eca30add2d
Signature · 1 line
2.44.0
Quoted 6 lines · Justin Tobler
The
SubmittingPatchesdocumentation briefly mentions that related patches should be grouped together in their own e-mail thread. Expand on this to explicitly state that updated versions of a patch series should also follow this. Also provide add a link to existing documentation fromMyFirstContributionthat provides detailed instructions on how to do this viagit-send-email(1).
Thankst! I obviously didn't read the old text in the intended way when I submitted my patch iterations yesterday, so your patch makes it much more clear!
- Roland
Quoted 31 lines
Signed-off-by Justin Tobler <[email protected]>--- Documentation/SubmittingPatches | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-)Documentation/SubmittingPatches +6
-4@@ -415,10 +415,12 @@ e-mail tools, so that they may comment on specific portions of your code. For this reason, each patch should be submitted "inline" in a separate message. -Multiple related patches should be grouped into their own e-mail -thread to help readers find all parts of the series. To that end, -send them as replies to either an additional "cover letter" message -(see below), the first patch, or the respective preceding patch. +All subsequent versions of a patch series and other related patches should be +grouped into their own e-mail thread to help readers find all parts of the +series. To that end, send them as replies to either an additional "cover +letter" message (see below), the first patch, or the respective preceding patch. +Here is a link:MyFirstContribution.html#v2-git-send-email[step-by-step guide] on +how to submit updated versions of a patch series. If your log message (including your name on the `Signed-off-by` trailer) is not writable in ASCII, make sure thatbase-commit:
e326e520101dcf43a0499c3adc2df7eca30add2dSignature · 1 line
2.44.0
Signature · 4 lines
Roland Hieber E-Mail: [email protected] Web: https://rohieb.name PGP Fingerprint: 3B7A C587 9464 CAB6 5B90 7151 B241 3C66 DD2C 3FEA
Quoted 17 lines · Justin Tobler
The
SubmittingPatchesdocumentation briefly mentions that related patches should be grouped together in their own e-mail thread. Expand on this to explicitly state that updated versions of a patch series should also follow this. Also provide add a link to existing documentation fromMyFirstContributionthat provides detailed instructions on how to do this viagit-send-email(1).Signed-off-by Justin Tobler <[email protected]>--- Documentation/SubmittingPatches | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-)Documentation/SubmittingPatches +0
-0
Documentation/SubmittingPatches e-mail tools, so that they may comment on specific portions of · line 418
Quoted 8 lines
Documentation/SubmittingPatches +1
-4@@ -415,10 +415,12 @@ e-mail tools, so that they may comment on specific portions of your code. For this reason, each patch should be submitted "inline" in a separate message. -Multiple related patches should be grouped into their own e-mail -thread to help readers find all parts of the series. To that end, -send them as replies to either an additional "cover letter" message -(see below), the first patch, or the respective preceding patch. +All subsequent versions of a patch series and other related patches should be
The 'other related patches' is not a strict rule we follow, is it?
Documentation/SubmittingPatches e-mail tools, so that they may comment on specific portions of · line 423
Quoted 5 lines
Documentation/SubmittingPatches +5
-0+grouped into their own e-mail thread to help readers find all parts of the +series. To that end, send them as replies to either an additional "cover +letter" message (see below), the first patch, or the respective preceding patch. +Here is a link:MyFirstContribution.html#v2-git-send-email[step-by-step guide] on +how to submit updated versions of a patch series.
Thanks for this.