From patchwork Thu Oct 20 14:13:49 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "\\(" X-Patchwork-Id: 43735 Return-Path: X-Original-To: patchwork@mira.cbaines.net Delivered-To: patchwork@mira.cbaines.net Received: by mira.cbaines.net (Postfix, from userid 113) id 1814827BBEA; Thu, 20 Oct 2022 15:57:21 +0100 (BST) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-3.7 required=5.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,MAILING_LIST_MULTI,RCVD_IN_MSPIKE_H2,SPF_HELO_PASS, URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.6 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id 8A7FF27BBE9 for ; Thu, 20 Oct 2022 15:57:19 +0100 (BST) Received: from localhost ([::1]:36564 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1olWyx-000563-EE for patchwork@mira.cbaines.net; Thu, 20 Oct 2022 10:57:15 -0400 Received: from [::1] (helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1olWto-0007Wc-PD for patchwork@mira.cbaines.net; Thu, 20 Oct 2022 10:51:56 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:56118) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1olWK7-0002RY-VW for guix-patches@gnu.org; Thu, 20 Oct 2022 10:15:15 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:36808) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1olWK6-0008Rj-Ph for guix-patches@gnu.org; Thu, 20 Oct 2022 10:15:03 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1olWK6-0005zO-GT for guix-patches@gnu.org; Thu, 20 Oct 2022 10:15:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#58648] [PATCH v2] doc: contributing: Expand "Sending a Patch Series". References: <20221019215709.24201-1-paren@disroot.org> In-Reply-To: <20221019215709.24201-1-paren@disroot.org> Resent-From: "(" Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Thu, 20 Oct 2022 14:15:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 58648 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 58648@debbugs.gnu.org Cc: "\(" Received: via spool by 58648-submit@debbugs.gnu.org id=B58648.166627526022958 (code B ref 58648); Thu, 20 Oct 2022 14:15:02 +0000 Received: (at 58648) by debbugs.gnu.org; 20 Oct 2022 14:14:20 +0000 Received: from localhost ([127.0.0.1]:35886 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1olWJN-0005yC-QG for submit@debbugs.gnu.org; Thu, 20 Oct 2022 10:14:20 -0400 Received: from knopi.disroot.org ([178.21.23.139]:40472) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1olWJJ-0005xy-5Q for 58648@debbugs.gnu.org; Thu, 20 Oct 2022 10:14:17 -0400 Received: from localhost (localhost [127.0.0.1]) by disroot.org (Postfix) with ESMTP id 528794E700; Thu, 20 Oct 2022 16:14:11 +0200 (CEST) X-Virus-Scanned: SPAM Filter at disroot.org Received: from knopi.disroot.org ([127.0.0.1]) by localhost (disroot.org [127.0.0.1]) (amavisd-new, port 10024) with UTF8SMTP id P8XfWrObuENx; Thu, 20 Oct 2022 16:14:09 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=disroot.org; s=mail; t=1666275235; bh=c+LiVrLIEGr/Sw+nmTtkM3zrG3OZeMt/vBRx5MYXu98=; h=From:To:Cc:Subject:Date; b=Z13xD//WR/ce0jm9jAWvRQWf3eG5NNueXwVn525dTfJONI8ZSwjPf0l50J4rhPqrs wxaemdR73mwRh0ITHC8KcfqKqXOWG/4j1zEur0xPXj487rV45o8+bhIzUMujsR+WlR DWkjCyY2cKtGBoxC/dy/biT7Whga6ukIoQyIZ84OkpqIesNCSsET/CEw+aGZTr16zT DCc+G3JCIUOjghqg+0y8fydHXknDZCyNr2LpHGzyCVlDI5bmEUNi2DMubca+lfYCDq Z3zVPfKk7AZ4ngWeiLrC/BnAAfazgl05pXwh+mpbRZgrv7nGYRzM3ESNKS9a8FNQnZ qSRchAmjSnAgw== Date: Thu, 20 Oct 2022 15:13:49 +0100 Message-Id: <20221020141349.4780-1-paren@disroot.org> Mime-Version: 1.0 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org Sender: "Guix-patches" Reply-to: "\(" X-ACL-Warn: , "\( via Guix-patches" X-Patchwork-Original-From: "\( via Guix-patches" via From: "\\(" X-getmail-retrieved-from-mailbox: Patches * doc/contributing.texi: Expand on sending patches and using git send-email. --- doc/contributing.texi | 120 ++++++++++++++++++++++++++++++------------ 1 file changed, 86 insertions(+), 34 deletions(-) base-commit: 88746cd80bc56212ae7922c0fa1cd9a18e44c3bb diff --git a/doc/contributing.texi b/doc/contributing.texi index 4b1eed1cb1..650d3430fb 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -1149,15 +1149,6 @@ Before submitting a patch that adds or modifies a package definition, please run through this check list: @enumerate -@cindex @code{git format-patch} -@cindex @code{git-format-patch} -@item -When generating your patches with @code{git format-patch} or @code{git -send-email}, we recommend using the option @code{--base=}, perhaps with -the value @code{auto}. This option adds a note to the patch stating -which commit the patch is based on. This helps reviewers understand how -to apply and review your patches. - @item If the authors of the packaged software provide a cryptographic signature for the release tarball, make an effort to verify the @@ -1343,18 +1334,6 @@ a subject, if your patch is to be applied on a branch other than @code{master}, say @code{core-updates}, specify it in the subject like @samp{[PATCH core-updates] @dots{}}. -@quotation Tip -To add a prefix to the subject of your patch, you may use the -@option{--subject-prefix} option of the @command{git format-patch} or -@command{git send-email} commands, for example: -@example -git send-email --subject-prefix='PATCH core-updates' \ - --to=guix-patches@@gnu.org -1 -@end example -For more information, run @samp{man git-format-patch} and @samp{man -git-send-email}. -@end quotation - You may use your email client or the @command{git send-email} command (@pxref{Sending a Patch Series}). We prefer to get patches in plain text messages, either inline or as MIME attachments. You are advised to @@ -1409,19 +1388,92 @@ git config --local sendemail.thread no @anchor{Sending a Patch Series} @cindex patch series @cindex @code{git send-email} +The @command{git send-email} and @command{git format-patch} commands allow +you to send your commits in email form to a mailing list, to be reviewed +and applied, and they are the recommended way to submit contributions to +Guix. When you send the first revision of a patch series, it's best to use +@command{git format-patch --cover-letter}. + +@example +$ git format-patch -$N -o outgoing --cover-letter --base=HEAD~$N +@end example + +@quotation Note +The @command{git send-email} command is provided by the @code{send-email} +output of the @code{git} package, i.e. @code{git:send-email}. +@end quotation + +This command makes patches out of the last @var{N} commits, and writes +them to @file{*.patch} files in @file{outgoing/}, along with an +automatically generated cover letter. The @option{--base=HEAD~$N} option +adds @code{base-commit: @var{COMMIT}} to the bottom of the first email. + +We can now send the cover letter to the Guix mailing list, using +@command{git send-email}. + +@example +$ git send-email outgoing/0000-cover-letter.patch -a --to guix-patches@@gnu.org +@end example + +Note the @option{-a} flag; this pops up your editor so that you can fill +in the patchset subject line and blurb with whatever explanatory text you +feel is appropriate. Note the automatically generated shortlog and +diffstat below the blurb, which help to give potential reviewers an +overview of the patchset. + +@quotation Tip +To add a prefix to the subject of your patch, you may use the +@option{--subject-prefix} option. + +@example +git format-patch -$N -o outgoing \ + --subject-prefix='PATCH core-updates' \ + --base=auto --cover-letter +@end example +@end quotation + +The use of the @file{etc/teams.scm} script to notify the appropriate team +members (@pxref{Teams}) is recommended when submitting patches, to maximize +the chances of your patch series being reviewed quickly. + +At some point, the Debbugs mailer will reply to your cover letter mail +with an acknowledgement, which contains the issue number of your patchset. +You should now send the rest of the patches to this issue thread, using +the @email{@var{ISSUE_NUMBER}@@debbugs.gnu.org} address. + +@example +$ rm outgoing/0000-cover-letter.patch # Don't resend the cover letter! +$ git send-email outgoing/*.patch --to ISSUE_NUMBER@@debbugs.gnu.org +$ rm -rf outgoing # We're done with the patch files now. +@end example + +After a moment, your patches should appear at +@url{https://issues.guix.gnu.org/@var{ISSUE_NUMBER}} and +@url{https://debbugs.gnu.org/@var{ISSUE_NUMBER}}. + +@quotation Note +You should @strong{never} send all your patches to +@email{guix-patches@@gnu.org} at once, as this will create an issue for +each individual patch you send! If you do accidentally do this, though, +it's not a massive problem, as Debbugs supports merging issues. +@end quotation + +To incorporate a reviewer's suggestions, use @command{git rebase -i} to +amendthe commits, as demonstrated @url{https://git-rebase.io, here}, and +send a second patch series with a @option{-v2} tag. + +@example +$ git send-email -$N -v2 --base=auto --to ISSUE_NUMBER@@debbugs.gnu.org +@end example -When sending a patch series (e.g., using @code{git send-email}), please -first send one message to @email{guix-patches@@gnu.org}, and then send -subsequent patches to @email{@var{NNN}@@debbugs.gnu.org} to make sure -they are kept together. See -@uref{https://debbugs.gnu.org/Advanced.html, the Debbugs documentation} -for more information. You can install @command{git send-email} with -@command{guix install git:send-email}. -@c Debbugs bug: https://debbugs.gnu.org/db/15/15361.html +Note that since we already have an issue on Debbugs for our patchset, +there's no need for the intermediate @command{git format-patch} step. Of +course, to send a third patchset, you amy use @option{-v3}, to send a +fourth, @option{-v4}, and so on. -To maximize the chances that you patch series is reviewed, the preferred -submission way is to use the @code{etc/teams.scm} script to notify the -appropriate team members (@pxref{Teams}). +If need be, you may use @option{--cover-letter -a} to send another cover +letter, e.g. for explaining what's changed since the last revision, and +these changes are necessary. @unnumberedsubsec Teams @anchor{Teams} @@ -1448,7 +1500,7 @@ You can run the following command to have the @code{Mentors} team put in CC of a patch series: @example -$ git send-email --to XXX@@debbugs.gnu.org $(./etc/teams.scm cc mentors) *.patch +$ git send-email --to @var{ISSUE_NUMBER}@@debbugs.gnu.org $(./etc/teams.scm cc mentors) *.patch @end example The appropriate team or teams can also be inferred from the modified @@ -1457,7 +1509,7 @@ current Git repository to review, you can run: @example $ guix shell -D guix -[env]$ git send-email --to XXX@@debbugs.gnu.org $(./etc/teams.scm cc-members HEAD~2 HEAD) *.patch +[env]$ git send-email --to @var{ISSUE_NUMBER}@@debbugs.gnu.org $(./etc/teams.scm cc-members HEAD~2 HEAD) *.patch @end example @node Tracking Bugs and Patches