[v3] doc: update guideline for fix commit messages

Message ID 20240201134852.2383699-1-venkatx.sivaramakrishnan@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series [v3] doc: update guideline for fix commit messages |

Checks

Context Check Description
ci/checkpatch warning coding style issues
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/github-robot: build success github build: passed
ci/intel-Functional success Functional PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-abi-testing success Testing PASS
ci/iol-unit-amd64-testing success Testing PASS
ci/iol-compile-amd64-testing success Testing PASS
ci/iol-unit-arm64-testing success Testing PASS
ci/iol-sample-apps-testing success Testing PASS
ci/iol-compile-arm64-testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS

Commit Message

Sivaramakrishnan Venkat Feb. 1, 2024, 1:48 p.m. UTC
  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@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(-)
  

Comments

Ferruh Yigit Feb. 6, 2024, 3:12 p.m. UTC | #1
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.sivaramakrishnan@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: author@example.com
>  
>       Signed-off-by: Alex Smith <alex.smith@example.com>
> +     ---
> +     Cc: author@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: author@example.com
>  
>       Signed-off-by: Alex Smith <alex.smith@example.com>
> +     ---
> +     Cc: author@example.com
>  
>  
>  `Bugzilla <https://bugs.dpdk.org>`_
> @@ -319,9 +321,10 @@ For example::
>  
>      Bugzilla ID: 12345
>      Fixes: abcdefgh1234 ("doc: add some parameter")
> -    Cc: author@example.com
>  
>      Signed-off-by: Alex Smith <alex.smith@example.com>
> +    ---
> +    Cc: author@example.com
>  
>  Patch for Stable Releases
>  ~~~~~~~~~~~~~~~~~~~~~~~~~
> @@ -336,9 +339,10 @@ 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: stable@dpdk.org
>  
>       Signed-off-by: Alex Smith <alex.smith@example.com>
> +     ---
> +     Cc: stable@dpdk.org
>  

We want to keep "Cc: stable@dpdk.org" in the commit log, so above it wrong.

Please only update "Cc: author@example.com" cases.
  

Patch

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: author@example.com
 
      Signed-off-by: Alex Smith <alex.smith@example.com>
+     ---
+     Cc: author@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: author@example.com
 
      Signed-off-by: Alex Smith <alex.smith@example.com>
+     ---
+     Cc: author@example.com
 
 
 `Bugzilla <https://bugs.dpdk.org>`_
@@ -319,9 +321,10 @@  For example::
 
     Bugzilla ID: 12345
     Fixes: abcdefgh1234 ("doc: add some parameter")
-    Cc: author@example.com
 
     Signed-off-by: Alex Smith <alex.smith@example.com>
+    ---
+    Cc: author@example.com
 
 Patch for Stable Releases
 ~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -336,9 +339,10 @@  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: stable@dpdk.org
 
      Signed-off-by: Alex Smith <alex.smith@example.com>
+     ---
+     Cc: stable@dpdk.org
 
 For further information on stable contribution you can go to
 :doc:`Stable Contribution Guide <stable>`.
diff --git a/doc/guides/contributing/stable.rst b/doc/guides/contributing/stable.rst
index 8156b72b20..bf7f4bceec 100644
--- a/doc/guides/contributing/stable.rst
+++ b/doc/guides/contributing/stable.rst
@@ -92,9 +92,10 @@  commit message body as follows::
      Update the docs, fixing description of some parameter.
 
      Fixes: abcdefgh1234 ("doc: add some parameter")
-     Cc: stable@dpdk.org
 
      Signed-off-by: Alex Smith <alex.smith@example.com>
+     ---
+     Cc: stable@dpdk.org
 
 
 Fixes not suitable for backport should not include the ``Cc: stable@dpdk.org`` tag.