From: Ferruh Yigit <ferruh.yigit@amd.com>
To: Sivaramakrishnan Venkat <venkatx.sivaramakrishnan@intel.com>
Cc: dev@dpdk.org, ciara.power@intel.com
Subject: Re: [PATCH v3] doc: update guideline for fix commit messages
Date: Tue, 6 Feb 2024 15:12:18 +0000 [thread overview]
Message-ID: <4ce1b0ff-f5ca-44b0-955d-4955a5cc4d93@amd.com> (raw)
In-Reply-To: <20240201134852.2383699-1-venkatx.sivaramakrishnan@intel.com>
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.
next prev parent reply other threads:[~2024-02-06 15:12 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 [this message]
2024-02-08 10:51 ` [PATCH v4] " Sivaramakrishnan Venkat
2024-02-08 11:36 ` 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=4ce1b0ff-f5ca-44b0-955d-4955a5cc4d93@amd.com \
--to=ferruh.yigit@amd.com \
--cc=ciara.power@intel.com \
--cc=dev@dpdk.org \
--cc=venkatx.sivaramakrishnan@intel.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).