[Buildroot] [git commit branch/2020.05.x] docs/manual: Add section about contributing to maintenance branches
Peter Korsgaard
peter at korsgaard.com
Tue Sep 15 17:46:44 UTC 2020
commit: https://git.buildroot.net/buildroot/commit/?id=60522566b41b5a2bd1dbfe495238ef3621b8d25a
branch: https://git.buildroot.net/buildroot/commit/?id=refs/heads/2020.05.x
Signed-off-by: Brandon Maier <brandon.maier at rockwellcollins.com>
[yann.morin.1998 at free.fr:
- s/release branch/maintenance branch/
- extend the master-then-backport section
- slight eye-candy on the rest
]
Signed-off-by: Yann E. MORIN <yann.morin.1998 at free.fr>
(cherry picked from commit 76ed69499d63ffb1e9167d36d794ebda6b17cd1a)
Signed-off-by: Peter Korsgaard <peter at korsgaard.com>
---
docs/manual/contribute.txt | 31 +++++++++++++++++++++++++++++++
1 file changed, 31 insertions(+)
diff --git a/docs/manual/contribute.txt b/docs/manual/contribute.txt
index bde7543c25..70d178d00b 100644
--- a/docs/manual/contribute.txt
+++ b/docs/manual/contribute.txt
@@ -371,6 +371,37 @@ in the following cases:
* whenever you feel it will help presenting your work, your choices,
the review process, etc.
+==== Patches for maintenance branches
+
+When fixing bugs on a maintenance branch, bugs should be fixed on the
+master branch first. The commit log for such a patch may then contain a
+post-commit note specifying what branches are affected:
+
+----
+package/foo: fix stuff
+
+Signed-off-by: Your Real Name <your at email.address>
+---
+Backport to: 2020.02.x, 2020.05.x
+(2020.08.x not affected as the version was bumped)
+----
+
+Those changes will then be backported by a maintainer to the affected
+branches.
+
+However, 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 maintenance branch, and the patch subject prefix
+must include the maintenance 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
+---------------------
+
+Then send the patches with +git send-email+, as described above.
+
==== Patch revision changelog
When improvements are requested, the new revision of each commit
More information about the buildroot
mailing list