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

Ferruh Yigit ferruh.yigit at amd.com
Wed Jan 31 03:14:06 CET 2024


On 1/30/2024 2:09 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.sivaramakrishnan at intel.com>
> ---
> v2:
>    - Samples updated to the desired format for the "Cc:" line in the commit message
> ---
>  doc/guides/contributing/patches.rst | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
> index e286d9e6d5..5687b5fa27 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: author at example.com
>  
>       Signed-off-by: Alex Smith <alex.smith at example.com>
> +     ---
> +     Cc: author at example.com
>  
>  * When fixing an error or warning it is useful to add the error message and instructions on how to reproduce it.
>  

There are multiple sample that has "Cc: author at example.com" line, can
you please update all for consistency?



More information about the dev mailing list