From patchwork Thu Nov 2 13:54:58 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Guinevere Larsen X-Patchwork-Id: 78943 Return-Path: X-Original-To: patchwork@sourceware.org Delivered-To: patchwork@sourceware.org Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id A0F683861826 for ; Thu, 2 Nov 2023 13:55:51 +0000 (GMT) X-Original-To: gdb-patches@sourceware.org Delivered-To: gdb-patches@sourceware.org Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by sourceware.org (Postfix) with ESMTPS id CAB06385697B for ; Thu, 2 Nov 2023 13:55:15 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org CAB06385697B Authentication-Results: sourceware.org; dmarc=pass (p=none dis=none) header.from=redhat.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=redhat.com ARC-Filter: OpenARC Filter v1.0.0 sourceware.org CAB06385697B Authentication-Results: server2.sourceware.org; arc=none smtp.remote-ip=170.10.133.124 ARC-Seal: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1698933317; cv=none; b=S3YHc2ZtyBnrN/FA9SVLEoD1h4kbPSJCSNPjPSNmHRc4mb4OUGynfHlXZL1A1AUSPMiWU+qD2hrgd502IiI7vnWDbSycI+FzAvqbbL8zc4tgq/a3gYcq7+efYjRVDlTK6uv8vyPBmKqqWrKezl7u9u+RqWwOXCcV7R8r9poHD1Q= ARC-Message-Signature: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1698933317; c=relaxed/simple; bh=YNOybxXzIc+Pd2pZhYL+ljadnrU/RrQPU8jOSAAN0P0=; h=DKIM-Signature:From:To:Subject:Date:Message-ID:MIME-Version; b=LXNCidMllpirdSD9X2c7R9dtw40t267VJl0LDeFH2qhvsrlRRBIhROw0s19riXAhHWnPnn6RZxZfyaAsF7acylAIR8eZu1mm1FyJ8YhNb/6vqZfBpslSfnamtOigHQCiRkrkNjwJpK9mFMX8oiN55DWoedfkzxD81qhkZ/XiQ8I= ARC-Authentication-Results: i=1; server2.sourceware.org DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1698933315; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=mAZldGV+ImxWGOmGP0IGERsaUkxKPw+GxJ1wBNS+Sl8=; b=WpgzbkFS1m77qla6RNW5ohzvYH5HaS7iKv/ND9ECJWBcuUfB//n/72+5fbL4cNY+u7RrOT W55ylGOFjHKieGDAviiX45K3wtI2lHJ/wpWG42Qqsd9xKJ/pWSKSY6RGU8Ek8tJz29acBD 6b624QZaPlOKmIt3RABPQtHWgBjBn0c= Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-480-SYrh5brPPKKhgJk7jGe0mQ-1; Thu, 02 Nov 2023 09:55:14 -0400 X-MC-Unique: SYrh5brPPKKhgJk7jGe0mQ-1 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.rdu2.redhat.com [10.11.54.6]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 017F6811E7E for ; Thu, 2 Nov 2023 13:55:14 +0000 (UTC) Received: from fedora.redhat.com (unknown [10.45.224.103]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 7A2C82166B26; Thu, 2 Nov 2023 13:55:13 +0000 (UTC) From: Guinevere Larsen To: gdb-patches@sourceware.org Cc: Guinevere Larsen Subject: [PATCH v6] [gdb]: add git trailer information on gdb/MAINTAINERS Date: Thu, 2 Nov 2023 14:54:58 +0100 Message-ID: <20231102135457.3663735-2-blarsen@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.6 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com X-Spam-Status: No, score=-11.7 required=5.0 tests=BAYES_00, DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, SPF_HELO_NONE, SPF_NONE, TXREP, T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org X-BeenThere: gdb-patches@sourceware.org X-Mailman-Version: 2.1.30 Precedence: list List-Id: Gdb-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: gdb-patches-bounces+patchwork=sourceware.org@sourceware.org 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. Simply put, the trailers in use work as follows: * Tested-by: The person tested the patch and it fixes the problem, or introduces no regressions (or both). * Acked-by: The general outline looks good, but the maintainer hasn't looked at the code * Reviewed-by: The code looks good, but the reviewer has not approved the patch to go upstream * Approved-by: The patch is ready to be pushed to master These last 3 trailers can also be restricted to one or more areas of GDB by adding the areas in a comma separated list in parenthesis after the trailers. Finally, for completeness sake, the trailers Co-Authored-By and Bug were added, even though they have been in use for a long time already Reviewed-by: Luis Machado --- gdb/MAINTAINERS | 93 ++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 85 insertions(+), 8 deletions(-) diff --git a/gdb/MAINTAINERS b/gdb/MAINTAINERS index 9989956065e..e1bb437a675 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,88 @@ 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 trailers (with the exception of +obvious patches, see below). The trailers (or tags) currently in use are: + + - 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 " + + - Acked-By: + + Used when a responsible or global maintaner has taken a superficial + look at a patch and agree with its direction, but has not done further + review on the subject. + This trailer can be specific to one or more areas of the project, as + defined by the "Responsible maintainers" section of this file. If + that is the case, the area(s) should be added at the end of the tag in + parenthesis in a comma separated list. + Usage: "Acked-By: Your Name (area1, area2)" + + - 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. + This trailer can be specific to one or more areas of the project, as + defined by the "Responsible maintainers" section of this file. If + that is the case, the area(s) should be added at the end of the tag in + parenthesis in a comma separated list. + Usage: "Reviewed-By: Your Name (area1, area2)" + + - Approved-by: + + Used by responsible maintainers or global maintainers when a patch is + ready to be upstreamed. If a patch requires multiple approvals, only + the last reviewer should use this tag, making it obvious to the + contributor that the patch is ready to be pushed. + This trailer can be specific to one or more areas of the project, as + defined by the "Responsible maintainers" section of this file. If + that is the case, the area(s) should be added at the end of the tag in + parenthesis in a comma separated list. Patches must have all areas + approved before being pushed. If a patch has had some areas approved, + it is recommended that the final approver makes it explicit that the + patch is ready for pushing. + 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 " + + - Co-Authored-By: + + Used when the commit includes meaningful conrtibutions from multiple people. + Usage: "Co-Authored-By: Contributor's Name " + + - Bug: + + This trailer is added with a link to the GDB bug tracker bug for + added context on relevant commits. + Usage: "Bug: " + +Sometimes, contributors may request small changes, such as fixing typos, before +granting the review or approval trailer. When the contributor thinks that +these changes are so small that it isn't necessary to send a new version, they +may add some text like "with these changes, I'm ok with the patch", followed by +their trailer. In those situations, the trailer is only valid after the +changes are made. + The Obvious Fix Rule --------------------