On 2/1/2024 1:48 PM, Sivaramakrishnan Venkat wrote:
> 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>
> ---
> v3:
> - Other samples updated to the desired format for the "Cc:" line in the
> commit message
> v2:
> - Samples updated to the desired format for the "Cc:" line in the commit
> message
> ---
> doc/guides/contributing/patches.rst | 12 ++++++++----
> doc/guides/contributing/stable.rst | 3 ++-
> 2 files changed, 10 insertions(+), 5 deletions(-)
>
> diff --git a/doc/guides/contributing/patches.rst
> b/doc/guides/contributing/patches.rst
> index e286d9e6d5..4e1768025e 100644
> --- a/doc/guides/contributing/patches.rst
> +++ b/doc/guides/contributing/patches.rst
> @@ -271,9 +271,10 @@ Here are some guidelines for the body of a commit
> message:
> Update the docs, fixing description of some parameter.
>
> Fixes: abcdefgh1234 ("doc: add some parameter")
> - Cc: aut...@example.com
>
> Signed-off-by: Alex Smith <alex.sm...@example.com>
> + ---
> + Cc: aut...@example.com
>
> * When fixing an error or warning it is useful to add the error message and
> instructions on how to reproduce it.
>
> @@ -300,9 +301,10 @@ in the body of the commit message. For example::
>
> Coverity issue: 12345
> Fixes: abcdefgh1234 ("doc: add some parameter")
> - Cc: aut...@example.com
>
> Signed-off-by: Alex Smith <alex.sm...@example.com>
> + ---
> + Cc: aut...@example.com
>
>
> `Bugzilla <https://bugs.dpdk.org>`_
> @@ -319,9 +321,10 @@ For example::
>
> Bugzilla ID: 12345
> Fixes: abcdefgh1234 ("doc: add some parameter")
> - Cc: aut...@example.com
>
> Signed-off-by: Alex Smith <alex.sm...@example.com>
> + ---
> + Cc: aut...@example.com
>
> Patch for Stable Releases
> ~~~~~~~~~~~~~~~~~~~~~~~~~
> @@ -336,9 +339,10 @@ In the commit message body the Cc: sta...@dpdk.org
> should be inserted as follows
> Update the docs, fixing description of some parameter.
>
> Fixes: abcdefgh1234 ("doc: add some parameter")
> - Cc: sta...@dpdk.org
>
> Signed-off-by: Alex Smith <alex.sm...@example.com>
> + ---
> + Cc: sta...@dpdk.org
>
We want to keep "Cc: sta...@dpdk.org" in the commit log, so above it wrong.
Please only update "Cc: aut...@example.com" cases.
