Maintainers remove the Cc author line when merging the patch.
So, the guidelines is updated with a suggestion for the placement
of Cc lines in a commit message for easy merging.
Signed-off-by: Sivaramakrishnan Venkat <venkatx.sivaramakrish...@intel.com>
---
doc/guides/contributing/patches.rst | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/doc/guides/contributing/patches.rst
b/doc/guides/contributing/patches.rst
index e286d9e6d5..e109365599 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -275,6 +275,12 @@ Here are some guidelines for the body of a commit message:
Signed-off-by: Alex Smith <alex.sm...@example.com>
+* .. Note::
+
+ Maintainers remove the "Cc: aut...@example.com" line when merging the
patch.
+ To help the maintainer, the submitter may move this line to the notes
section
+ of the commit, after the ``---`` separator.
+
* When fixing an error or warning it is useful to add the error message and
instructions on how to reproduce it.
* Use correct capitalization, punctuation and spelling.
--
2.25.1
