[v2] doc: clarify adding author to commit message
diff mbox series

Message ID 20200801231143.36993-1-honnappa.nagarahalli@arm.com
State Superseded, archived
Delegated to: Thomas Monjalon
Headers show
Series
  • [v2] doc: clarify adding author to commit message
Related show

Checks

Context Check Description
ci/travis-robot success Travis build: passed
ci/checkpatch warning coding style issues

Commit Message

Honnappa Nagarahalli Aug. 1, 2020, 11:11 p.m. UTC
Clarify to add the author of the commit in CC while contributing
patches to stable. git-send-email will automatically send the
the patch to this email ID. It is manually removed when the patch
is merged.

Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
---
v2: expand commit log to explain how Cc is used (Thomas)

 doc/guides/contributing/patches.rst | 1 +
 doc/guides/contributing/stable.rst  | 1 +
 2 files changed, 2 insertions(+)

Patch
diff mbox series

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index 16b40225f..282c1fec3 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -329,6 +329,7 @@  In the commit message body the Cc: stable@dpdk.org should be inserted as follows
      Update the docs, fixing description of some parameter.
 
      Fixes: abcdefgh1234 ("doc: add some parameter")
+     Cc: author@example.com
      Cc: stable@dpdk.org
 
      Signed-off-by: Alex Smith <alex.smith@example.com>
diff --git a/doc/guides/contributing/stable.rst b/doc/guides/contributing/stable.rst
index 890bbeccc..747d4bc7c 100644
--- a/doc/guides/contributing/stable.rst
+++ b/doc/guides/contributing/stable.rst
@@ -85,6 +85,7 @@  commit message body as follows::
      Update the docs, fixing description of some parameter.
 
      Fixes: abcdefgh1234 ("doc: add some parameter")
+     Cc: author@example.com
      Cc: stable@dpdk.org
 
      Signed-off-by: Alex Smith <alex.smith@example.com>