[PATCH] doc: clarify practices for submitting updated patch versions

[PATCH] doc: clarify practices for submitting updated patch versions

[Justin Tobler]

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)`.

Signed-off-by: Justin Tobler <jltobler@gmail.com>
---
 Documentation/SubmittingPatches | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index c647c7e1b4..bc212836f9 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -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
-- 
2.44.0

Re: [PATCH] doc: clarify practices for submitting updated patch versions

[Roland Hieber]

On Thu, Apr 25, 2024 at 04:34:04PM -0500, Justin Tobler wrote:
> 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)`.

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

> Signed-off-by: Justin Tobler <jltobler@gmail.com>
> ---
>  Documentation/SubmittingPatches | 10 ++++++----
>  1 file changed, 6 insertions(+), 4 deletions(-)
> 
> diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
> index c647c7e1b4..bc212836f9 100644
> --- a/Documentation/SubmittingPatches
> +++ b/Documentation/SubmittingPatches
> @@ -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
> -- 
> 2.44.0
> 

-- 
Roland Hieber
E-Mail: rohieb@rohieb.name
Web: https://rohieb.name
PGP Fingerprint: 3B7A C587 9464 CAB6 5B90  7151 B241 3C66 DD2C 3FEA

Re: [PATCH] doc: clarify practices for submitting updated patch versions

[Karthik Nayak]

[-- Attachment #1: Type: text/plain, Size: 1814 bytes --]

Justin Tobler <jltobler@gmail.com> writes:

> 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)`.
>
> Signed-off-by: Justin Tobler <jltobler@gmail.com>
> ---
>  Documentation/SubmittingPatches | 10 ++++++----
>  1 file changed, 6 insertions(+), 4 deletions(-)
>
> diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
> index c647c7e1b4..bc212836f9 100644
> --- a/Documentation/SubmittingPatches
> +++ b/Documentation/SubmittingPatches
> @@ -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?

> +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.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 690 bytes --]