From: Ferruh Yigit <ferruh.yigit@amd.com>
To: Sivaramakrishnan Venkat <venkatx.sivaramakrishnan@intel.com>
Cc: dev@dpdk.org
Subject: Re: [PATCH v1] doc: update guideline for fix commit messages
Date: Thu, 25 Jan 2024 11:24:24 +0000 [thread overview]
Message-ID: <e94213e2-1622-4b3c-9cd4-ec80b75eba72@amd.com> (raw)
In-Reply-To: <20240125033900.1894397-1-venkatx.sivaramakrishnan@intel.com>
On 1/25/2024 3:39 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>
> ---
> doc/guides/contributing/patches.rst | 6 ++++++
> 1 file changed, 6 insertions(+)
>
> diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
> index e286d9e6d5..e109365599 100644
> --- a/doc/guides/contributing/patches.rst
> +++ b/doc/guides/contributing/patches.rst
> @@ -275,6 +275,12 @@ Here are some guidelines for the body of a commit message:
>
> Signed-off-by: Alex Smith <alex.smith@example.com>
>
> +* .. Note::
> +
> + Maintainers remove the "Cc: author@example.com" line when merging the patch.
> + To help the maintainer, the submitter may move this line to the notes section
> + of the commit, after the ``---`` separator.
> +
> * When fixing an error or warning it is useful to add the error message and instructions on how to reproduce it.
>
> * Use correct capitalization, punctuation and spelling.
Thanks Sivaramakrishnan for the doc update, that is practically what
happens,
but "Note" is to get additional attention, and there are already
multiple steps involved to prepare a commit log and this one is not
really that important, so lets not complicate it more for new contributors.
One option is add above information without ".. Note::" block, and
shorten it a little more, with adding the reasoning of adding "Cc:
author@example.com" (so I am asking adding more info and make paragraph
shorter :)
Other option is update samples to the desired format, it won't explain
the ask but imply it by showing requested output, as we are doing for
"Depends-on" tag.
I am for starting with the second option first, update samples, and see
if it improves things, what do you think?
next prev parent reply other threads:[~2024-01-25 11:24 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-25 3:39 Sivaramakrishnan Venkat
2024-01-25 11:24 ` Ferruh Yigit [this message]
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 ` [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=e94213e2-1622-4b3c-9cd4-ec80b75eba72@amd.com \
--to=ferruh.yigit@amd.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).