[PATCH v1] doc: update guideline for fix commit messages

Sivaramakrishnan Venkat venkatx.sivaramakrishnan at intel.com
Thu Jan 25 04:39:00 CET 2024


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.sivaramakrishnan at 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.smith at example.com>
 
+* .. Note::
+
+     Maintainers remove the "Cc: author at 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



More information about the dev mailing list