Skip to contentSkip to conversation

docs/manual: Add section about contributing to release branches

PATCH New Brandon Maier 3 participants 3 messages Sep 8, 2020 – Sep 15, 2020

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 docs/manual: Add section about contributing to release branches

---
Changes v2:
- Forgot to save before commiting, mention to base branch of release branch, add example

 docs/manual/contribute.txt | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
docs/manual/contribute.txt +16 -0
index 11d8811b44..85d7111735 100644
@@ -371,6 +371,22 @@ in the following cases:
 * whenever you feel it will help presenting your work, your choices,
   the review process, etc.
 
+==== Patches for release branches
+
+When fixing bugs on a release branch, bugs should be fixed on the master
+branch first. Then the release branch maintainer can backport the fixes
+to the correct release branches. But some bugs may apply only to a
+specific release, for example because it is using an older version of a
+package. In that case, patches should be based off the release branch,
+and the patch's subject prefix must include the release branch name (for
+example "[PATCH 2020.02.x]"). This can be done with the +git
+format-patch+ flag +--subject-prefix+.
+
+---------------------
+$ git format-patch --subject-prefix "PATCH 2020.02.x" \
+    -M -s -o outgoing origin/2020.02.x
+---------------------
+
 ==== Patch revision changelog
 
 When improvements are requested, the new revision of each commit
Signature · 1 line
2.28.0
#1 lore raw

PATCH v2 1/1 docs/manual: Add section about contributing to release branches

Brandon, All,

On 2020-09-08 17:05 -0500, Brandon Maier spake thusly:

Quoted 1 line

Applied to master, with the following changes:

- s/release branch/maintenance branch/
- extend the master-then-backport section
- slight eye-candy on the rest

Thanks!

Regards,
Yann E. MORIN.

Quoted 38 lines

---
Changes v2:
- Forgot to save before commiting, mention to base branch of release branch, add example

 docs/manual/contribute.txt | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
docs/manual/contribute.txt +16 -0
index 11d8811b44..85d7111735 100644
@@ -371,6 +371,22 @@ in the following cases:
 * whenever you feel it will help presenting your work, your choices,
   the review process, etc.
 
+==== Patches for release branches
+
+When fixing bugs on a release branch, bugs should be fixed on the master
+branch first. Then the release branch maintainer can backport the fixes
+to the correct release branches. But some bugs may apply only to a
+specific release, for example because it is using an older version of a
+package. In that case, patches should be based off the release branch,
+and the patch's subject prefix must include the release branch name (for
+example "[PATCH 2020.02.x]"). This can be done with the +git
+format-patch+ flag +--subject-prefix+.
+
+---------------------
+$ git format-patch --subject-prefix "PATCH 2020.02.x" \
+    -M -s -o outgoing origin/2020.02.x
+---------------------
+
 ==== Patch revision changelog
 
 When improvements are requested, the new revision of each commit
Signature · 1 line
2.28.0
Signature · 6 lines
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 561 099 427 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'
#2 lore raw

PATCH v2 1/1 docs/manual: Add section about contributing to release branches

In reply to Brandon Maier
Quoted 7 lines
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line

"Brandon" == Brandon Maier <[email protected]> writes:

---
Changes v2:
- Forgot to save before commiting, mention to base branch of release branch, add example

Committed to 2020.02.x, 2020.05.x and 2020.08.x, thanks.

Signature · 1 line
Bye, Peter Korsgaard