From: Dmitry Baryshkov <dmitry.baryshkov@linaro.org>
To: Jonathan Corbet <corbet@lwn.net>
Cc: workflows@vger.kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org, linux-arm-msm@vger.kernel.org,
Dmitry Baryshkov <dmitry.baryshkov@linaro.org>
Subject: [PATCH] docs: submitting-patches: describe additional tags
Date: Mon, 01 Apr 2024 08:17:03 +0300 [thread overview]
Message-ID: <20240401-additional-trailers-v1-1-f472bf158d2f@linaro.org> (raw)
Described tags do not fully cover development needs. For example the LKP
robot insists on using Reported-by: tag, but that's not fully correct.
The robot reports an issue with the patch, not the issue that is being
fixed by the patch. Describe additional tags to be used while submitting
patches.
Signed-off-by: Dmitry Baryshkov <dmitry.baryshkov@linaro.org>
---
Documentation/process/submitting-patches.rst | 19 +++++++++++++++++++
1 file changed, 19 insertions(+)
diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
index 66029999b587..3a24d90fa385 100644
--- a/Documentation/process/submitting-patches.rst
+++ b/Documentation/process/submitting-patches.rst
@@ -544,6 +544,25 @@ future patches, and ensures credit for the testers.
Reviewed-by:, instead, indicates that the patch has been reviewed and found
acceptable according to the Reviewer's Statement:
+Additional tags to be used while submitting patches
+---------------------------------------------------
+
+The tags described previously do not always cover the needs of the development
+process.
+
+For example, if the kernel test robot reports an issue in the patch, the robot
+insists that the next version of the patch gets the Reported-by: and Closes:
+tags. While the Closes: tag can be considered correct in such a case, the
+Reported-by: tag is definitely not correct. The LKP robot hasn't reported the
+issue that is being fixed by the patch, but instead it has reported an issue
+with the patch. To be more precise you may use the Improved-thanks-to: tag for
+the next version of the patch.
+
+Another frequent case is when you want to express gratitude to the colleagues,
+who helped to improve the patch, but neither the Co-developed-by: nor
+Suggested-by: tags are appropriate. In such case you might prefer to use
+Discussed-with:, Listened-by:, or Discussed-over-a-beer-with: tags.
+
Reviewer's statement of oversight
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
---
base-commit: 13ee4a7161b6fd938aef6688ff43b163f6d83e37
change-id: 20240401-additional-trailers-2b764f3e4aee
Best regards,
--
Dmitry Baryshkov <dmitry.baryshkov@linaro.org>
next reply other threads:[~2024-04-01 5:17 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-01 5:17 Dmitry Baryshkov [this message]
2024-04-01 16:19 ` Nikita Travkin
2024-04-02 18:59 ` Bjorn Andersson
2024-04-04 16:18 ` Dmitry Baryshkov
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=20240401-additional-trailers-v1-1-f472bf158d2f@linaro.org \
--to=dmitry.baryshkov@linaro.org \
--cc=corbet@lwn.net \
--cc=linux-arm-msm@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=workflows@vger.kernel.org \
/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