[v4] doc: update guideline for fix commit messages

Message ID 20240208105113.2458550-1-venkatx.sivaramakrishnan@intel.com (mailing list archive)
State New
Delegated to: Thomas Monjalon
Headers
Series [v4] 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 fail github build: failed
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-abi-testing success Testing PASS
ci/iol-compile-amd64-testing success Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-unit-amd64-testing success Testing PASS
ci/intel-Functional success Functional PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-unit-arm64-testing success Testing PASS
ci/iol-sample-apps-testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-compile-arm64-testing success Testing PASS

Commit Message

Sivaramakrishnan Venkat Feb. 8, 2024, 10:51 a.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>
---
v4:
  - Reverted removal of "Cc: stable@dpdk.org" in the commit log
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 | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)
  

Comments

Ferruh Yigit Feb. 8, 2024, 11:36 a.m. UTC | #1
On 2/8/2024 10:51 AM, 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>
>

Acked-by: Ferruh Yigit <ferruh.yigit@amd.com>
  

Patch

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index e286d9e6d5..7605ea4d64 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
 ~~~~~~~~~~~~~~~~~~~~~~~~~