doc: clarify adding author to commit message
diff mbox series

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

Checks

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

Commit Message

Honnappa Nagarahalli June 30, 2020, 7:01 p.m. UTC
Clarify to add the author in CC while contributing patches to stable.

Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
---
 doc/guides/contributing/patches.rst | 1 +
 doc/guides/contributing/stable.rst  | 1 +
 2 files changed, 2 insertions(+)

Comments

Thomas Monjalon July 30, 2020, 11:18 p.m. UTC | #1
30/06/2020 21:01, Honnappa Nagarahalli:
> Clarify to add the author in CC while contributing patches to stable.

Not only for stable.

We should explain in this commit log that this Cc is for automatic
handling by git-send-email.
It is manually removed when pushing in the git repository
to avoid naming people who were not involved
(acked-by or reviewed-by are added if they are involved).


> Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
> ---
>  doc/guides/contributing/patches.rst | 1 +
>  doc/guides/contributing/stable.rst  | 1 +
>  2 files changed, 2 insertions(+)
> 
> 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>

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>