From: Sivaramakrishnan Venkat <venkatx.sivaramakrishnan@intel.com>
Cc: dev@dpdk.org, ciara.power@intel.com, ferruh.yigit@amd.com,
Sivaramakrishnan Venkat <venkatx.sivaramakrishnan@intel.com>
Subject: [PATCH v4] doc: update guideline for fix commit messages
Date: Thu, 8 Feb 2024 10:51:13 +0000 [thread overview]
Message-ID: <20240208105113.2458550-1-venkatx.sivaramakrishnan@intel.com> (raw)
In-Reply-To: <20240125033900.1894397-1-venkatx.sivaramakrishnan@intel.com>
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(-)
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
~~~~~~~~~~~~~~~~~~~~~~~~~
--
2.25.1
next prev parent reply other threads:[~2024-02-08 10:51 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-25 3:39 [PATCH v1] " Sivaramakrishnan Venkat
2024-01-25 11:24 ` Ferruh Yigit
2024-01-30 14:09 ` [PATCH v2] " Sivaramakrishnan Venkat
2024-01-31 2:14 ` Ferruh Yigit
2024-02-01 13:48 ` [PATCH v3] " Sivaramakrishnan Venkat
2024-02-06 15:12 ` Ferruh Yigit
2024-02-08 10:51 ` Sivaramakrishnan Venkat [this message]
2024-02-08 11:36 ` [PATCH v4] " Ferruh Yigit
2024-03-20 9:59 ` Power, Ciara
2024-03-24 23:38 ` Thomas Monjalon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240208105113.2458550-1-venkatx.sivaramakrishnan@intel.com \
--to=venkatx.sivaramakrishnan@intel.com \
--cc=ciara.power@intel.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@amd.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).