Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Bruno Larsen via Gdb-patches <gdb-patches@sourceware.org>
To: gdb-patches@sourceware.org
Cc: pedro@palves.net, aburgess@redhat.com, kevinb@redhat.com,
	brobecker@adacore.com, simon.marchi@polymtl.ca, tom@tromey.com,
	tdevries@suse.de, ulrich.weigand@de.ibm.com, eliz@gnu.org,
	Bruno Larsen <blarsen@redhat.com>
Subject: [PATCH v4 1/1] [gdb]: add git trailer information on gdb/MAINTAINERS
Date: Thu, 13 Jul 2023 12:56:53 +0200	[thread overview]
Message-ID: <20230713105651.2281574-4-blarsen@redhat.com> (raw)
In-Reply-To: <20230713105651.2281574-2-blarsen@redhat.com>

The project has been using Tested-By (tb), Reviewed-By (rb) and
Approved-By (ab) for some time, but there has been no information to be
found in the actual repository. This commit changes that by adding
information about all git trailers to the MAINTAINERS file, so that it
can be easily double-checked.

The upstream discussion also brought up the use of Acked-by, which is
better defined in this commit.  Finally, for completeness sake, the
trailers Co-Authored-By and Bug were added, even though they have been
in use for some time already
---
 gdb/MAINTAINERS | 72 +++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 64 insertions(+), 8 deletions(-)

diff --git a/gdb/MAINTAINERS b/gdb/MAINTAINERS
index 7fa608fd82c..609f740f21d 100644
--- a/gdb/MAINTAINERS
+++ b/gdb/MAINTAINERS
@@ -43,14 +43,9 @@ patch without review from another maintainer.  This especially includes
 patches which change internal interfaces (e.g. global functions, data
 structures) or external interfaces (e.g. user, remote, MI, et cetera).
 
-The term "review" is used in this file to describe several kinds of feedback
-from a maintainer: approval, rejection, and requests for changes or
-clarification with the intention of approving a revised version.  Review is
-a privilege and/or responsibility of various positions among the GDB
-Maintainers.  Of course, anyone - whether they hold a position but not the
-relevant one for a particular patch, or are just following along on the
-mailing lists for fun, or anything in between - may suggest changes or
-ask questions about a patch!
+The word "contributor" is used in this document to refer to any GDB
+developer listed above as well as folks who may have suggested some
+patches but aren't part of one of those categories for any reason.
 
 There's also a couple of other people who play special roles in the GDB
 community, separately from the patch process:
@@ -78,6 +73,67 @@ consensus among the global maintainers and any other involved parties.
 In cases where consensus can not be reached, the global maintainers may
 ask the official FSF-appointed GDB maintainers for a final decision.
 
+The term "review" is used in this file to describe several kinds of
+feedback from a maintainer: approval, rejection, and requests for changes
+or clarification with the intention of approving a revised version.
+Approval is a privilege and/or responsibility of various positions among
+the GDB Maintainers.  Of course, anyone - whether they hold a position, but
+not the relevant one for a particular patch, or are just following along on
+the mailing lists for fun, or anything in between - may suggest changes, ask
+questions about a patch or say if they believe a patch is fit for upstreaming!
+
+To ensure that patches are only pushed when approved, and to properly credit
+the contributors who take the time to improve this project, the following
+trailers are used to identify who contributed and how.  All patches pushed
+upstream should have at least one Approved-By patches (with the exception of
+obvious patches, see below).  The trailers (or tags) currently in use are:
+
+ - Acked-By:
+
+   Used when a contributor has taken a quick glance at a patch and agrees
+   with the direction outlined in the commit message, but hasn't evaluated
+   the code for correctness or regressions.
+   Usage: "Acked-By: Your Name <your@email>"
+
+ - Tested-by:
+
+   Used when a contributor has tested the patch and finds that it
+   fixes the claimed problem.  It may also be used to indicate that
+   the contributor has performed regression testing.  By itself, this
+   tag says nothing about the quality of the fix implemented by the
+   patch, nor the amount of testing that was actually performed.
+   Usage: "Tested-By: Your Name <your@email>"
+
+ - Reviewed-by:
+
+   Used when a contributor has looked at the code and agrees with
+   the changes, but either doesn't have the authority or doesn't
+   feel comfortable approving the patch.
+   Usage: "Reviewed-By: Your Name <your@email>"
+
+ - Approved-by:
+
+   Used by responsible maintainers or global maintainers when a patch is
+   ready to be upstreamed.  Some patches may touch multiple areas and
+   require multiple approvals before landing (such as a maintainer only
+   approving documentation), it is up to the maintainer giving the approval
+   tag to make it clear when that a tag is not sufficient. Responsible,
+   Global and Official FSF-appointed maintainers may approve their own
+   patches, but it is recommended that they seek external approval before
+   doing so.
+   Usage: "Approved-By: Your Name <your@email>"
+
+ - Co-Authored-By:
+
+   Used when the commit includes meaningful conrtibutions from multiple people.
+   Usage: "Co-Authored-By: Contributor's Name <their@email>"
+
+ - Bug:
+
+   This trailer is added with a link to the GDB bug tracker bug for
+   added context on relevant commits.
+   Usage: "Bug: <link>"
+
 
 			The Obvious Fix Rule
 			--------------------
-- 
2.41.0


  reply	other threads:[~2023-07-13 11:09 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-07-13 10:56 [PATCH v3 0/1] update MAINTAINERS file with git trailers Bruno Larsen via Gdb-patches
2023-07-13 10:56 ` Bruno Larsen via Gdb-patches [this message]
2023-07-13 21:24   ` [PATCH v4 1/1] [gdb]: add git trailer information on gdb/MAINTAINERS Kevin Buettner via Gdb-patches
2023-07-13 21:50 ` [PATCH v3 0/1] update MAINTAINERS file with git trailers Kevin Buettner via Gdb-patches
2023-07-14  5:50   ` Eli Zaretskii via Gdb-patches
2023-07-14 10:11     ` Bruno Larsen via Gdb-patches

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=20230713105651.2281574-4-blarsen@redhat.com \
    --to=gdb-patches@sourceware.org \
    --cc=aburgess@redhat.com \
    --cc=blarsen@redhat.com \
    --cc=brobecker@adacore.com \
    --cc=eliz@gnu.org \
    --cc=kevinb@redhat.com \
    --cc=pedro@palves.net \
    --cc=simon.marchi@polymtl.ca \
    --cc=tdevries@suse.de \
    --cc=tom@tromey.com \
    --cc=ulrich.weigand@de.ibm.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