From df93e7aeeee6dc33da4ae4691917eba0432285c9 Mon Sep 17 00:00:00 2001 From: Eric Engestrom Date: Wed, 10 Nov 2021 11:08:05 +0000 Subject: [PATCH] docs/submittingpatches: mention use of the `-x` flag of `git cherry-pick` when backporting a commit Signed-off-by: Eric Engestrom Part-of: --- docs/submittingpatches.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/submittingpatches.rst b/docs/submittingpatches.rst index 66e77639d4c..35dd7fb71be 100644 --- a/docs/submittingpatches.rst +++ b/docs/submittingpatches.rst @@ -360,6 +360,12 @@ appropriate. The MR should be based on and target the per the stable branch policy. Assigning the MR to release maintainer for said branch or mentioning them is helpful, but not required. +Make sure to use ``git cherry-pick -x`` when cherry-picking the commits +from the main branch. This adds the "cherry picked from commit ..." line +to the commit message, to allow the release maintainters to mark those +as backported, which in turn allows the tools to correctly report any +future ``Fixes:`` affecting the commits you backported. + Documentation patches ---------------------