doc: advise to specify LTS branch when backporting patches
PATCH 1/1 doc: advise to specify LTS branch when backporting patches
From: Luca Boccassi <[email protected]>
We have many stable branches being maintaned at the same time, and sometimes it's not clear which branch a patch is being backported for. Note in the guidelines that it should be specified via the cover letter, annotation or using --subject-prefix.
Also note to send only to [email protected], not [email protected].
--- doc/guides/contributing/patches.rst | 8 ++++++++ 1 file changed, 8 insertions(+)
doc/guides/contributing/patches.rst +8 -0
@@ -450,6 +450,14 @@ Experienced committers may send patches directly with ``git send-email`` without The options ``--annotate`` and ``confirm = always`` are recommended for checking patches before sending. +Backporting patches for Stable Releases +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Sometimes a maintainer or contributor wishes, or can be asked, to send a patch for a stable release rather than mainline. In this case the patch(es) should be sent to ``[email protected]``, not to ``[email protected]``. + +Given that there are multiple stable releases being maintained at the same time, please specify exactly which branch the patch is for in the cover letter, in the annotation or using ``git send-email --subject-prefix='16.11' ...`` + + The Review Process ------------------
Signature · 1 line
2.14.2
Quoted 3 lines · On 05/16/2018 03:31 PM, [email protected] wrote:
From: Luca Boccassi <[email protected]>
We have many stable branches being maintaned at the same time, and
typo
Quoted 15 lines
sometimes it's not clear which branch a patch is being backported for. Note in the guidelines that it should be specified via the cover letter, annotation or using --subject-prefix.
Also note to send only to [email protected], not [email protected].Signed-off-by Luca Boccassi <[email protected]>--- doc/guides/contributing/patches.rst | 8 ++++++++ 1 file changed, 8 insertions(+)doc/guides/contributing/patches.rst +0
-0
doc/guides/contributing/patches.rst Experienced committers may send patches directly with ``git send-email`` without · line 459
Quoted 10 lines
doc/guides/contributing/patches.rst +7
-0@@ -450,6 +450,14 @@ Experienced committers may send patches directly with ``git send-email`` without The options ``--annotate`` and ``confirm = always`` are recommended for checking patches before sending. +Backporting patches for Stable Releases +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Sometimes a maintainer or contributor wishes, or can be asked, to send a patch for a stable release rather than mainline. In this case the patch(es) should be sent to ``[email protected]``, not to ``[email protected]``. + +Given that there are multiple stable releases being maintained at the same time, please specify exactly which branch the patch is for in the cover letter, in the annotation or using ``git send-email --subject-prefix='16.11' ...`` +
s/branch/branch(es)/
How about [16.11] instead of '16.11' ?
I would be in favour that the prefix(es) should always be added for this very specific case, as it will make it stand out more.
either way,
Quoted 5 lines
doc/guides/contributing/patches.rst +1
-0+ The Review Process ------------------
Quoted 46 lines · Kevin Traynor
Quoted 3 lines · On 05/16/2018 03:31 PM, [email protected] wrote:
From: Luca Boccassi <[email protected]>
We have many stable branches being maintaned at the same time, and
typo
Quoted 32 lines
sometimes it's not clear which branch a patch is being backported for.
Note in the guidelines that it should be specified via the cover letter,
annotation or using --subject-prefix.
Also note to send only to [email protected], not [email protected].Signed-off-by Luca Boccassi <[email protected]>---
doc/guides/contributing/patches.rst | 8 ++++++++1 file changed, 8 insertions(+)doc/guides/contributing/patches.rst +0
-0@@ -450,6 +450,14 @@ Experienced committers may send patchesdirectly with ``git send-email`` without
The options ``--annotate`` and ``confirm = always`` are recommended for checking patches before sending.doc/guides/contributing/patches.rst +4
-0+Backporting patches for Stable Releases +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Sometimes a maintainer or contributor wishes, or can be asked, tosend a patch for a stable release rather than mainline. In this case the patch(es) should be sent to ``[email protected]``, not to `` [email protected]``.
doc/guides/contributing/patches.rst +2
-0+ +Given that there are multiple stable releases being maintained atQuoted 4 lines
the same time, please specify exactly which branch the patch is for in the cover letter, in the annotation or using ``git send-email -- subject-prefix='16.11' ...``
+s/branch/branch(es)/
Quoted 1 line
How about [16.11] instead of '16.11' ?
Using --subject-prefix git will already use "[PATCH 16.11]
Quoted 6 lines
I would be in favour that the prefix(es) should always be added for this
very specific case, as it will make it stand out more.either way,
Acked-by Kevin Traynor <[email protected]>
Makes sense, I've slightly re-arranged to wording for that
Signature · 2 lines
Kind regards, Luca Boccassi
16/05/2018 19:03, Luca Boccassi:
Quoted 47 lines · Kevin Traynor
Quoted 46 lines · On 05/16/2018 03:31 PM, [email protected] wrote:
Quoted 3 lines
From: Luca Boccassi <[email protected]>
We have many stable branches being maintaned at the same time, and
typo
Quoted 32 lines
sometimes it's not clear which branch a patch is being backported for.
Note in the guidelines that it should be specified via the cover letter,
annotation or using --subject-prefix.
Also note to send only to [email protected], not [email protected].Signed-off-by Luca Boccassi <[email protected]>--- doc/guides/contributing/patches.rst | 8 ++++++++ 1 file changed, 8 insertions(+)doc/guides/contributing/patches.rst +0
-0@@ -450,6 +450,14 @@ Experienced committers may send patchesdirectly with ``git send-email`` without
The options ``--annotate`` and ``confirm = always`` are
recommended for checking patches before sending.doc/guides/contributing/patches.rst +4
-0+Backporting patches for Stable Releases +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Sometimes a maintainer or contributor wishes, or can be asked, tosend a patch for a stable release rather than mainline. In this case the patch(es) should be sent to ``[email protected]``, not to `` [email protected]``.
doc/guides/contributing/patches.rst +2
-0+ +Given that there are multiple stable releases being maintained atQuoted 4 lines
the same time, please specify exactly which branch the patch is for in the cover letter, in the annotation or using ``git send-email -- subject-prefix='16.11' ...``
+s/branch/branch(es)/
Quoted 3 lines
Quoted 1 line
How about [16.11] instead of '16.11' ?
Using --subject-prefix git will already use "[PATCH 16.11]
I think it should be --subject-prefix='PATCH 16.11'
Please wrap the lines after some punctuation signs to avoid really long lines in the rst file.
Quoted 58 lines · Thomas Monjalon
16/05/2018 19:03, Luca Boccassi:
Quoted 57 lines · Kevin Traynor
Quoted 55 lines · On 05/16/2018 03:31 PM, [email protected] wrote:
Quoted 4 lines
From: Luca Boccassi <[email protected]>
We have many stable branches being maintaned at the same time, and
typo
Quoted 36 lines
sometimes it's not clear which branch a patch is being backported
for.
Note in the guidelines that it should be specified via the cover
letter,
annotation or using --subject-prefix.
Also note to send only to [email protected], not [email protected].Signed-off-by Luca Boccassi <[email protected]>---
doc/guides/contributing/patches.rst | 8 ++++++++1 file changed, 8 insertions(+)doc/guides/contributing/patches.rst +0
-0@@ -450,6 +450,14 @@ Experienced committers may send patchesdirectly with ``git send-email`` without
The options ``--annotate`` and ``confirm = always`` are recommended for checking patches before sending.doc/guides/contributing/patches.rst +4
-0+Backporting patches for Stable Releases +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Sometimes a maintainer or contributor wishes, or can be asked,to
send a patch for a stable release rather than mainline. In this case the patch(es) should be sent to ``[email protected]``, not to ``
[email protected]``.doc/guides/contributing/patches.rst +2
-0+ +Given that there are multiple stable releases being maintainedQuoted 7 lines
at
the same time, please specify exactly which branch the patch is for
in the cover letter, in the annotation or using ``git send- email --
subject-prefix='16.11' ...``
+s/branch/branch(es)/
How about [16.11] instead of '16.11' ?
Quoted 7 lines
Quoted 1 line
Using --subject-prefix git will already use "[PATCH 16.11]
I think it should be --subject-prefix='PATCH 16.11'
Please wrap the lines after some punctuation signs to avoid really long lines
in the rst file.
Ok, done both in v3.
Signature · 2 lines
Kind regards, Luca Boccassi
PATCH v2 1/1 doc: advise to specify LTS branch when backporting patches
In reply to [email protected]From: Luca Boccassi <[email protected]>
We have many stable branches being maintained at the same time, and sometimes it's not clear which branch a patch is being backported for. Note in the guidelines that it should be specified via the cover letter, annotation or using --subject-prefix.
Also note to send only to [email protected], not [email protected].
---
v2: hint that --subject-prefix is required, fix typos
doc/guides/contributing/patches.rst | 8 ++++++++ 1 file changed, 8 insertions(+)
doc/guides/contributing/patches.rst +8 -0
@@ -450,6 +450,14 @@ Experienced committers may send patches directly with ``git send-email`` without The options ``--annotate`` and ``confirm = always`` are recommended for checking patches before sending. +Backporting patches for Stable Releases +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Sometimes a maintainer or contributor wishes, or can be asked, to send a patch for a stable release rather than mainline. In this case the patch(es) should be sent to ``[email protected]``, not to ``[email protected]``. + +Given that there are multiple stable releases being maintained at the same time, please specify exactly which branch(es) the patch is for using ``git send-email --subject-prefix='16.11' ...`` and also optionally in the cover letter or in the annotation. + + The Review Process ------------------
Signature · 1 line
2.14.2
Quoted 8 lines · On 05/16/2018 06:05 PM, [email protected] wrote:
From: Luca Boccassi <[email protected]>
We have many stable branches being maintained at the same time, and sometimes it's not clear which branch a patch is being backported for. Note in the guidelines that it should be specified via the cover letter, annotation or using --subject-prefix.
Also note to send only to [email protected], not [email protected].
Quoted 28 lines
Signed-off-by Luca Boccassi <[email protected]>---
v2: hint that --subject-prefix is required, fix typos
doc/guides/contributing/patches.rst | 8 ++++++++ 1 file changed, 8 insertions(+)doc/guides/contributing/patches.rst +8
-0@@ -450,6 +450,14 @@ Experienced committers may send patches directly with ``git send-email`` without The options ``--annotate`` and ``confirm = always`` are recommended for checking patches before sending. +Backporting patches for Stable Releases +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Sometimes a maintainer or contributor wishes, or can be asked, to send a patch for a stable release rather than mainline. In this case the patch(es) should be sent to ``[email protected]``, not to ``[email protected]``. + +Given that there are multiple stable releases being maintained at the same time, please specify exactly which branch(es) the patch is for using ``git send-email --subject-prefix='16.11' ...`` and also optionally in the cover letter or in the annotation. + + The Review Process ------------------
PATCH v3 1/1 doc: advise to specify LTS branch when backporting patches
In reply to [email protected]From: Luca Boccassi <[email protected]>
We have many stable branches being maintained at the same time, and sometimes it's not clear which branch a patch is being backported for. Note in the guidelines that it should be specified via the cover letter, annotation or using --subject-prefix.
Also note to send only to [email protected], not [email protected].
---
v3: break long lines, fix subject-prefix argument to include PATH
v2: hint that --subject-prefix is required, fix typos
doc/guides/contributing/patches.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+)
doc/guides/contributing/patches.rst +12 -0
@@ -450,6 +450,18 @@ Experienced committers may send patches directly with ``git send-email`` without The options ``--annotate`` and ``confirm = always`` are recommended for checking patches before sending. +Backporting patches for Stable Releases +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Sometimes a maintainer or contributor wishes, or can be asked, to send a patch for a stable release +rather than mainline. In this case the patch(es) should be sent to ``[email protected]``, +not to ``[email protected]``. + +Given that there are multiple stable releases being maintained at the same time, please specify +exactly which branch(es) the patch is for using ``git send-email --subject-prefix='PATCH 16.11' ...`` +and also optionally in the cover letter or in the annotation. + + The Review Process ------------------
Signature · 1 line
2.14.2
17/05/2018 15:53, [email protected]:
Quoted 9 lines
From: Luca Boccassi <[email protected]>
We have many stable branches being maintained at the same time, and sometimes it's not clear which branch a patch is being backported for. Note in the guidelines that it should be specified via the cover letter, annotation or using --subject-prefix.
Also note to send only to [email protected], not [email protected].Signed-off-by Luca Boccassi <[email protected]>
Applied, thanks