From unknown Thu Jun 19 14:06:58 2025 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-Mailer: MIME-tools 5.509 (Entity 5.509) Content-Type: text/plain; charset=utf-8 From: bug#58648 <58648@debbugs.gnu.org> To: bug#58648 <58648@debbugs.gnu.org> Subject: Status: [PATCH 0/1] doc: contributing: Expand "Sending a Patch Series". Reply-To: bug#58648 <58648@debbugs.gnu.org> Date: Thu, 19 Jun 2025 21:06:58 +0000 retitle 58648 [PATCH 0/1] doc: contributing: Expand "Sending a Patch Series= ". reassign 58648 guix-patches submitter 58648 "(" severity 58648 normal tag 58648 patch thanks From debbugs-submit-bounces@debbugs.gnu.org Wed Oct 19 17:57:37 2022 Received: (at submit) by debbugs.gnu.org; 19 Oct 2022 21:57:37 +0000 Received: from localhost ([127.0.0.1]:60354 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1olH4C-0006TD-Nb for submit@debbugs.gnu.org; Wed, 19 Oct 2022 17:57:37 -0400 Received: from lists.gnu.org ([209.51.188.17]:56928) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1olH45-0006Sy-7R for submit@debbugs.gnu.org; Wed, 19 Oct 2022 17:57:35 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:56460) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1olH41-0002bP-Al for guix-patches@gnu.org; Wed, 19 Oct 2022 17:57:26 -0400 Received: from knopi.disroot.org ([178.21.23.139]:53258) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1olH3v-0002hq-69 for guix-patches@gnu.org; Wed, 19 Oct 2022 17:57:24 -0400 Received: from localhost (localhost [127.0.0.1]) by disroot.org (Postfix) with ESMTP id C368E4E884; Wed, 19 Oct 2022 23:57:14 +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 ESMTP id LYBQXJpO6fM4; Wed, 19 Oct 2022 23:57:13 +0200 (CEST) From: "(" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=disroot.org; s=mail; t=1666216633; bh=PPNkcHuk9APwNHTRrYP1JtPiKDkwL269f8chY3VjWho=; h=From:To:Cc:Subject:Date; b=Gsi5Npt7e0OrUsAZJyzJDwH5z27OEiLajnFKO/B3HQVbkR0klPL6F02HIhNu/vi3M 5/NOOFMKOgjBf0+4SccXgkAm982GBmD58kV1rn3iyvL5VHSLEd4O0ZKNvduafZS0Jf Rb/lB4jLXXi6K54czgsglshEfBKxhPeiSYnBgcHDGnrk4ClgixKt+FhjdwDuIlv9Wj VTn8LWEuyoPVEGBWVcoB8TRvHS+2HLXC/1P9IeR0EtSkMo3AtOgOZ86alhWJKQmG/D 8S3m09GMNZ6yvtkHMxVHyEw2JUtVABZvhuQGX97cjdLtN66cJd/YOZJd+wJFE/vafa T3ilnOKQysd3A== To: guix-patches@gnu.org Subject: [PATCH 0/1] doc: contributing: Expand "Sending a Patch Series". Date: Wed, 19 Oct 2022 22:57:09 +0100 Message-Id: <20221019215709.24201-1-paren@disroot.org> Mime-Version: 1.0 Content-Transfer-Encoding: 8bit Received-SPF: pass client-ip=178.21.23.139; envelope-from=paren@disroot.org; helo=knopi.disroot.org X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, SPF_HELO_NONE=0.001, T_SPF_TEMPERROR=0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-Spam-Score: -0.0 (/) X-Debbugs-Envelope-To: submit Cc: "\(" X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) This patch significantly expands the "Sending a Patch Series" section of "Contributing". ( (1): doc: contributing: Expand "Sending a Patch Series". doc/contributing.texi | 83 ++++++++++++++++++++++++++++++++++++------- 1 file changed, 71 insertions(+), 12 deletions(-) -- 2.38.0 From debbugs-submit-bounces@debbugs.gnu.org Wed Oct 19 18:01:31 2022 Received: (at 58648) by debbugs.gnu.org; 19 Oct 2022 22:01:31 +0000 Received: from localhost ([127.0.0.1]:60363 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1olH7y-0006cA-UM for submit@debbugs.gnu.org; Wed, 19 Oct 2022 18:01:31 -0400 Received: from knopi.disroot.org ([178.21.23.139]:43216) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1olH7w-0006bw-AV for 58648@debbugs.gnu.org; Wed, 19 Oct 2022 18:01:29 -0400 Received: from localhost (localhost [127.0.0.1]) by disroot.org (Postfix) with ESMTP id 2345A4E8A9; Thu, 20 Oct 2022 00:01:27 +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 Vk-1iqy7RRgc; Thu, 20 Oct 2022 00:01:25 +0200 (CEST) From: "(" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=disroot.org; s=mail; t=1666216851; bh=FYnxkTHrqF0kM05U3XecCfaoGDjNzs3EyPZ6KGJM6XY=; h=From:To:Cc:Subject:Date; b=Q23oEbRxtomwtAliMF7KydSn02vug3kmlAJ9jUoKAg3ghcAx50RppCPAPaOHWfEuu uqJ408HdgXEvvhzOKhqtlOqvLfq2ciEg/ekceXN+k7OMO1xzwx0TDCuvQF17gUijeO OFEbJ3OVJD2wM87N4h8K0KXD2bB16xVO/k3a1Q2gqjIFzDFCEC9eReSl8XZKleBh5K TYzdYBZSycrb0NBd4bt8PO3U6VgMCH3yxJCMKI+eaYG3BkuIt7mqk9DveewWHRaEn8 3bBSwlQ2B0XqLR74y1QenuxEwD8/EdtPgjPmtBzkW+GUEtXk4NYjqr+9FwGn2MIQDT gDzyDM2bZrFyQ== To: 58648@debbugs.gnu.org Subject: [PATCH 1/1] doc: contributing: Expand "Sending a Patch Series". Date: Wed, 19 Oct 2022 23:00:48 +0100 Message-Id: <20221019220048.24290-1-paren@disroot.org> Mime-Version: 1.0 Content-Transfer-Encoding: 8bit X-Spam-Score: 1.3 (+) X-Spam-Report: Spam detection software, running on the system "debbugs.gnu.org", has NOT identified this incoming email as spam. The original message has been attached to this so you can view it or label similar future email. If you have any questions, see the administrator of that system for details. Content preview: * doc/contributing.texi: Expand on sending patches and using git send-email. --- doc/contributing.texi | 83 ++++++++++++++++++++++++++++++++++++------- 1 file changed, 71 insertions(+), 12 deletions(- [...] Content analysis details: (1.3 points, 10.0 required) pts rule name description ---- ---------------------- -------------------------------------------------- 1.3 FROM_ONE_CHAR Bogus FROM name -0.0 SPF_PASS SPF: sender matches SPF record 0.0 SPF_HELO_NONE SPF: HELO does not publish an SPF Record X-Debbugs-Envelope-To: 58648 Cc: "\(" X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: 0.3 (/) * doc/contributing.texi: Expand on sending patches and using git send-email. --- doc/contributing.texi | 83 ++++++++++++++++++++++++++++++++++++------- 1 file changed, 71 insertions(+), 12 deletions(-) diff --git a/doc/contributing.texi b/doc/contributing.texi index 4b1eed1cb1..c7a2dd09e7 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -1409,19 +1409,78 @@ git config --local sendemail.thread no @anchor{Sending a Patch Series} @cindex patch series @cindex @code{git send-email} +The @code{git send-email} and @code{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 +@code{git format-patch --cover-letter}. -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 - -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}). +@example +$ git format-patch -$N -o outgoing --cover-letter +@end example + +@quotation Note +The @code{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 @code{.patch} files in @code{outgoing/}, along with an automatically +generated cover letter. We can then send the cover letter to the Guix +mailing list. + +@example +$ git send-email outgoing/0000-cover-letter.patch -a --to guix-patches@@gnu.org +@end example + +Note the @code{-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. + +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 @code{@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 +@code{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 + +The use of the @code{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. + +To incorporate a reviewer's suggestions, use @code{git rebase -i} to amend +the commits, as demonstrated @url{https://git-rebase.io, here}, and send a +second patch series with a @code{-v2} tag. + +@example +$ git send-email -$N -v2 --to ISSUE_NUMBER@@debbugs.gnu.org +@end example + +Note that since we already have an issue on Debbugs for our patchset, +there's no need for the intermediate @code{git format-patch} step. Of +course, to send a third patchset, you amy use @code{-v3}, to send a fourth, +@code{-v4}, and so on. + +If need be, you may use @code{--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} -- 2.38.0 From debbugs-submit-bounces@debbugs.gnu.org Thu Oct 20 04:56:58 2022 Received: (at 58648) by debbugs.gnu.org; 20 Oct 2022 08:56:58 +0000 Received: from localhost ([127.0.0.1]:32941 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1olRMH-0006Z1-Ma for submit@debbugs.gnu.org; Thu, 20 Oct 2022 04:56:58 -0400 Received: from mail-wm1-f43.google.com ([209.85.128.43]:40849) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1olRMC-0006Xy-Bi for 58648@debbugs.gnu.org; Thu, 20 Oct 2022 04:56:53 -0400 Received: by mail-wm1-f43.google.com with SMTP id v130-20020a1cac88000000b003bcde03bd44so1786282wme.5 for <58648@debbugs.gnu.org>; Thu, 20 Oct 2022 01:56:52 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:message-id:date:references :in-reply-to:subject:cc:to:from:from:to:cc:subject:date:message-id :reply-to; bh=JSHw0bZLj66LPAjJWXAWBgXdZQdIP0M7ANfFBtWf1yc=; b=NeLezWnR8CH6gQE43MoMdZBt+z92qPRCOTp+hHeOvEKc1KAhdItOY2zVoIeAmtdXO7 FdG4OmNty14X4COzwrpXZhIT90KYMot9MzITFlSXvKc12q9YgQ22RG/PXcb/EDf8fXc3 Am0TWY7rvfMtTBVk4kYU3sS6PEGUFsNnoHNo8v97OrDbzIuf8p+xN24zTc36RI9KAil/ mfPFpj7N+McbCV+F5V7Efy64BUmQPE2EYE/pyKnVoy8hkeAGJFN4AX3cIrT8MH29kuvm mQj4ihjNgIMMEEUv5kxsfsA97DuwqiC3oz3O4057CS5RqBaeKDRXgwoaWFBbAWVmH1QH kCUA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:message-id:date:references :in-reply-to:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=JSHw0bZLj66LPAjJWXAWBgXdZQdIP0M7ANfFBtWf1yc=; b=acIlpX018a12UT9StgtifYBnqXnFXsC8367tclmShI6xCHvX8QRK+vCVZwZidnNMP7 aiPUmxZ7WHrHl2PAiu4XRd8TkB+TXJrlWg0JW5qy5E39evYS1CYy+23Gv9SlEqhF0S5Y P+yHmO/GFjJTlYUxUJH4+0I/F4JLP3w3Y9FY96RjC6ayvq1Jjp2CdaweAxhpNN0hNUcQ Iq39t7H/yxTKrBuXl7vfOnBH5sO5FH0+FplK4WWBr6K+U+n0v5IfSCNE4Zc4VX1/W706 RMFHr9lzgdOSeNBrtg9RZ+4T/4ovJ7ERD+FxFVStb7eWuq6dhbrKvZ2De1W4cEx0xBgw SKlw== X-Gm-Message-State: ACrzQf0Dm6DaOHJSCD1meCxrQg607saUnGjumAHvdboGbAJmLyOBC0wG pWy60807YTWNAErq5znNSdg= X-Google-Smtp-Source: AMsMyM6HPvn/klo6s1gCRxp/tMy3O/mk8X++FMffOlbUXq0KnJYUsSpYLVbBwHBKjlhd01Dp5VbieQ== X-Received: by 2002:a05:600c:3592:b0:3c6:f9db:a954 with SMTP id p18-20020a05600c359200b003c6f9dba954mr8457999wmq.170.1666256206523; Thu, 20 Oct 2022 01:56:46 -0700 (PDT) Received: from pfiuh07 ([193.48.40.241]) by smtp.gmail.com with ESMTPSA id g11-20020a5d488b000000b0022eafed36ebsm15869079wrq.73.2022.10.20.01.56.46 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 20 Oct 2022 01:56:46 -0700 (PDT) From: zimoun To: "( via Guix-patches via" , 58648@debbugs.gnu.org Subject: Re: [bug#58648] [PATCH 1/1] doc: contributing: Expand "Sending a Patch Series". In-Reply-To: <20221019220048.24290-1-paren@disroot.org> References: <20221019215709.24201-1-paren@disroot.org> <20221019220048.24290-1-paren@disroot.org> Date: Thu, 20 Oct 2022 10:56:25 +0200 Message-ID: <87a65qkh52.fsf@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 58648 Cc: "\(" X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) Hi, Minor suggestions, for what they are worth. :-) On mer., 19 oct. 2022 at 23:00, "\( via Guix-patches" via wrote: > +The @code{git send-email} and @code{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 Gui= x. > +When you send the first revision of a patch series, it's best to use > +@code{git format-patch --cover-letter}. > +@example > +$ git format-patch -$N -o outgoing --cover-letter > +@end example Here=E2=80=A6 > + > +@quotation Note > +The @code{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 @code{.patch} files in @code{outgoing/}, along with an automatic= ally > +generated cover letter. We can then send the cover letter to the Guix > +mailing list. =E2=80=A6or in these explanations, I would also suggest the option =E2=80= =99--base=E2=80=99; as recommended by item #1 in subsection =C2=ABSubmitting Patches=C2=BB. [...] > +At some point, the Debbugs mailer will reply to your cover letter mail > +with an acknowledgement, which contains the issue number of your patchse= t. > +You should now send the rest of the patches to this issue thread, using > +the @code{@var{ISSUE_NUMBER}@@debbugs.gnu.org} address. I agree that ISSUE_NUMBER is a better name than NNN or else. Therefore, maybe it could be worth to also tweak it in the section Teams. [...] > +The use of the @code{etc/teams.scm} script to notify the appropriate team > +members (@pxref{Teams}) is recommended when submitting patches, to maxim= ize > +the chances of your patch series being reviewed quickly. I would advertise about Teams early in this section. Maybe in the first paragraph. Cheers, simon From debbugs-submit-bounces@debbugs.gnu.org Thu Oct 20 04:59:38 2022 Received: (at submit) by debbugs.gnu.org; 20 Oct 2022 08:59:38 +0000 Received: from localhost ([127.0.0.1]:32970 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1olROr-0006f5-Pu for submit@debbugs.gnu.org; Thu, 20 Oct 2022 04:59:38 -0400 Received: from lists.gnu.org ([209.51.188.17]:54662) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1olROm-0006es-Je for submit@debbugs.gnu.org; Thu, 20 Oct 2022 04:59:36 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:60170) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1olROh-0005Fa-Ed for guix-patches@gnu.org; Thu, 20 Oct 2022 04:59:31 -0400 Received: from knopi.disroot.org ([178.21.23.139]:48660) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1olROf-0007S9-HF for guix-patches@gnu.org; Thu, 20 Oct 2022 04:59:27 -0400 Received: from localhost (localhost [127.0.0.1]) by disroot.org (Postfix) with ESMTP id 7BD264E88A; Thu, 20 Oct 2022 10:59:23 +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 ESMTP id Yl6RuxRxpPqJ; Thu, 20 Oct 2022 10:59:22 +0200 (CEST) Mime-Version: 1.0 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=disroot.org; s=mail; t=1666256361; bh=KRpu0xL4kGGQnINayNz+74QWCBVjyoBN8xGjmt0UWao=; h=Date:From:To:Subject:References:In-Reply-To; b=fZZS/68cUWLWSgMjielrJGIUe5qKA0OBDdfNyaViLOVyjGOKUY1T9wn5V1xEXZEBt AoFh5ev/3Auvxy0AEU2GkGui4VkVWmHkDkbbFxy6KWFK0Dk3NlcvPAb4MaRdhkeQ35 atNM1kmE4LZI2NhO4j9OBvC5N+WeF40gO7NMwpY5b2t+kR/CDCY4thco3HqwY1qY4U riZj4NAQk7TL6sQHS3IiC564fyzntuWLPV8TQqFgLjosc5jR67CtXhrmJIWxtSIT1T zUrN+tsVj328Amq3a3h+VLLjGP0px+VmomUtOu2bqtCm6+9/w+4SKlmX/YtiyUPX3o DrHVpRtF0AU4Q== Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset=UTF-8 Date: Thu, 20 Oct 2022 09:59:21 +0100 Message-Id: From: "(" To: "zimoun" , "( via Guix-patches via" , <58648@debbugs.gnu.org> Subject: Re: [bug#58648] [PATCH 1/1] doc: contributing: Expand "Sending a Patch Series". References: <20221019215709.24201-1-paren@disroot.org> <20221019220048.24290-1-paren@disroot.org> <87a65qkh52.fsf@gmail.com> In-Reply-To: <87a65qkh52.fsf@gmail.com> Received-SPF: pass client-ip=178.21.23.139; envelope-from=paren@disroot.org; helo=knopi.disroot.org X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-Spam-Score: -0.0 (/) X-Debbugs-Envelope-To: submit X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) Heya Simon, On Thu Oct 20, 2022 at 9:56 AM BST, zimoun wrote: > On mer., 19 oct. 2022 at 23:00, "\( via Guix-patches" via wrote: > > +@example > > +$ git format-patch -$N -o outgoing --cover-letter > > +@end example > > Here=E2=80=A6 > > > + > > +@quotation Note > > +The @code{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 @code{.patch} files in @code{outgoing/}, along with an automat= ically > > +generated cover letter. We can then send the cover letter to the Guix > > +mailing list. > > =E2=80=A6or in these explanations, I would also suggest the option =E2=80= =99--base=E2=80=99; as > recommended by item #1 in subsection =C2=ABSubmitting Patches=C2=BB. Oh, cool, I didn't know about ``--base'' :) I'll add that in. > > +At some point, the Debbugs mailer will reply to your cover letter mail > > +with an acknowledgement, which contains the issue number of your patch= set. > > +You should now send the rest of the patches to this issue thread, usin= g > > +the @code{@var{ISSUE_NUMBER}@@debbugs.gnu.org} address. > > I agree that ISSUE_NUMBER is a better name than NNN or else. Therefore, > maybe it could be worth to also tweak it in the section Teams. Okay. > > +The use of the @code{etc/teams.scm} script to notify the appropriate t= eam > > +members (@pxref{Teams}) is recommended when submitting patches, to max= imize > > +the chances of your patch series being reviewed quickly. > > I would advertise about Teams early in this section. Maybe in the first > paragraph. Alright! -- ( From debbugs-submit-bounces@debbugs.gnu.org Thu Oct 20 10:14:20 2022 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) From: "(" 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== To: 58648@debbugs.gnu.org Subject: [PATCH v2] doc: contributing: Expand "Sending a Patch Series". Date: Thu, 20 Oct 2022 15:13:49 +0100 Message-Id: <20221020141349.4780-1-paren@disroot.org> Mime-Version: 1.0 Content-Transfer-Encoding: 8bit X-Spam-Score: 1.3 (+) X-Spam-Report: Spam detection software, running on the system "debbugs.gnu.org", has NOT identified this incoming email as spam. The original message has been attached to this so you can view it or label similar future email. If you have any questions, see the administrator of that system for details. Content preview: * doc/contributing.texi: Expand on sending patches and using git send-email. --- doc/contributing.texi | 120 ++++++++++++++++++++++++++++++ 1 file changed, 86 insertions(+), 34 deletions(- [...] Content analysis details: (1.3 points, 10.0 required) pts rule name description ---- ---------------------- -------------------------------------------------- 1.3 FROM_ONE_CHAR Bogus FROM name -0.0 SPF_PASS SPF: sender matches SPF record 0.0 SPF_HELO_NONE SPF: HELO does not publish an SPF Record X-Debbugs-Envelope-To: 58648 Cc: "\(" X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: 0.3 (/) * doc/contributing.texi: Expand on sending patches and using git send-email. --- doc/contributing.texi | 120 ++++++++++++++++++++++++++++++------------ 1 file changed, 86 insertions(+), 34 deletions(-) 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 base-commit: 88746cd80bc56212ae7922c0fa1cd9a18e44c3bb -- 2.38.0 From debbugs-submit-bounces@debbugs.gnu.org Sat Oct 22 07:21:45 2022 Received: (at 58648) by debbugs.gnu.org; 22 Oct 2022 11:21:45 +0000 Received: from localhost ([127.0.0.1]:39819 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1omCZU-0001PW-Np for submit@debbugs.gnu.org; Sat, 22 Oct 2022 07:21:45 -0400 Received: from mail-ed1-f66.google.com ([209.85.208.66]:36753) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1omCZQ-0001P4-BA for 58648@debbugs.gnu.org; Sat, 22 Oct 2022 07:21:42 -0400 Received: by mail-ed1-f66.google.com with SMTP id e18so14823131edj.3 for <58648@debbugs.gnu.org>; Sat, 22 Oct 2022 04:21:40 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=mime-version:user-agent:content-transfer-encoding:references :in-reply-to:date:to:from:subject:message-id:from:to:cc:subject:date :message-id:reply-to; bh=X/UqpsC0RwR4Np5UREmVxMidPNODmLmEOamP5wKelEY=; b=fCyNPpXlnUbeQgP3xIMZjXvpO9tyFZVM8YIv5q0f2YEET4RGmCFZ61pf7c5lJulW/s r6o7TtxvQ/+xg3AHR8xs55w2tbV4ETr4BJspj0moqUAeq2dTDeBTVMAdiiONpblG18OE /gKnX0G9HWGkAvEz66XqQ4iwuO+l73MiftTaUAFKDQp0WFCb08UKTBZVU2tBs6xMwanu MTRjNrMTUZQvcGwtH3h+xNaobw0m3QXAnY0I21M47V3Kr74GcNmUrHXGi+grq7wYsFxx QMh+gTYMLZLXnxwxU2NWCgwAhDIZAmaNxh0l+tqvWrhdbAEXHt58i5G32sBW6cTXq6xU rtVA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=mime-version:user-agent:content-transfer-encoding:references :in-reply-to:date:to:from:subject:message-id:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=X/UqpsC0RwR4Np5UREmVxMidPNODmLmEOamP5wKelEY=; b=zoEhRxLW9CCwGZNDG4fwF8v6572gEQXmput8xWVz4RUdWTzFlT+psuIJwwc0bEI537 m75Yu4UE1ayCD73VnlPfyolY/OXAfAMeX5H9j5yxzD+6794kHtq88+HR+gixKiaMzfxz 76SqQrfd7cVEHDiaeHZsQlhN0yPTmFT1XxxwRzjlm1kMUtW5+2se2EhstStfqMLmuN+M 8+BmC15aVxckfgajedNrMEEbqm92sIVhpvrGPrC5cFUrClsGAVNEEilP5MNl7V9VW1+x oaPSNNzvxtrpkBNpXjYAUiSVB/TNjd+vMolJnnQ5ZzyaNkfbjNnv0g0JUpQg9Egdv1FF ViKg== X-Gm-Message-State: ACrzQf2wZH5Ac4V0GKXV74pvuoNGF1zs5l4jeG27TAfFlp6HlvI2cqMS Y9gLo7ZWw52iECwd+j0IE9Y= X-Google-Smtp-Source: AMsMyM7d345LsAlFb4yjpCxiZN/1Uky9E2/Dm91PdNl/e16J8VY7zaN+oRg6zzXYSnVIL+wLdQousw== X-Received: by 2002:a17:906:770d:b0:73c:a08f:593c with SMTP id q13-20020a170906770d00b0073ca08f593cmr20231309ejm.182.1666437693907; Sat, 22 Oct 2022 04:21:33 -0700 (PDT) Received: from lumine.fritz.box (85-127-52-93.dsl.dynamic.surfer.at. [85.127.52.93]) by smtp.gmail.com with ESMTPSA id ku16-20020a170907789000b0078ca30ee18bsm12911591ejc.95.2022.10.22.04.21.33 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 22 Oct 2022 04:21:33 -0700 (PDT) Message-ID: <9c9a4925aedab67b99f928084ecc7d46fda75f20.camel@gmail.com> Subject: Re: [PATCH v2] doc: contributing: Expand "Sending a Patch Series". From: Liliana Marie Prikler To: "(" , 58648@debbugs.gnu.org Date: Sat, 22 Oct 2022 13:21:30 +0200 In-Reply-To: <20221020141349.4780-1-paren@disroot.org> References: <20221020141349.4780-1-paren@disroot.org> Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable User-Agent: Evolution 3.46.0 MIME-Version: 1.0 X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 58648 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) Am Donnerstag, dem 20.10.2022 um 15:13 +0100 schrieb (: > * doc/contributing.texi: Expand on sending patches and using > =C2=A0 git send-email. > --- > =C2=A0doc/contributing.texi | 120 ++++++++++++++++++++++++++++++---------= - > -- > =C2=A01 file changed, 86 insertions(+), 34 deletions(-) >=20 > 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, > =C2=A0please run through this check list: > =C2=A0 > =C2=A0@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=3D}, perhaps > with > -the value @code{auto}.=C2=A0 This option adds a note to the patch statin= g > -which commit the patch is based on.=C2=A0 This helps reviewers understan= d > how > -to apply and review your patches. > - > =C2=A0@item > =C2=A0If the authors of the packaged software provide a cryptographic > =C2=A0signature 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 > =C2=A0@code{master}, say @code{core-updates}, specify it in the subject > like > =C2=A0@samp{[PATCH core-updates] @dots{}}. > =C2=A0 > -@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=3D'PATCH core-updates' \ > -=C2=A0 --to=3Dguix-patches@@gnu.org -1 > -@end example > -For more information, run @samp{man git-format-patch} and @samp{man > -git-send-email}. > -@end quotation > - > =C2=A0You may use your email client or the @command{git send-email} > command > =C2=A0(@pxref{Sending a Patch Series}).=C2=A0 We prefer to get patches in= plain > =C2=A0text messages, either inline or as MIME attachments.=C2=A0 You are > advised to > @@ -1409,19 +1388,92 @@ git config --local sendemail.thread no > =C2=A0@anchor{Sending a Patch Series} > =C2=A0@cindex patch series > =C2=A0@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=3DHEAD~$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.=C2=A0 The @option{--base=3DHEAD~$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.=C2=A0 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 \ > +=C2=A0=C2=A0=C2=A0 --subject-prefix=3D'PATCH core-updates' \ > +=C2=A0=C2=A0=C2=A0 --base=3Dauto --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. I think you should also elaborate how this script is to be used. > +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!=C2=A0 If you do accidentally do this, > though, > +it's not a massive problem, as Debbugs supports merging issues. > +@end quotation Perhaps=C2=A0 @quotation Caution Do @strong{not} send all your patches at once, as this will create an issue for each individual patch. While Debbugs supports merging=C2=A0 issues, some interfaces (e.g. Mumi) still treat them as separate in certain ways, which can lower or exaggerate visibility and annoy reviewers. @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 amend the > +send a second patch series with a @option{-v2} tag. > + > +@example > +$ git send-email -$N -v2 --base=3Dauto --to > ISSUE_NUMBER@@debbugs.gnu.org > +@end example > =C2=A0 > -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.=C2=A0 See > -@uref{https://debbugs.gnu.org/Advanced.html, the Debbugs > documentation} > -for more information.=C2=A0 You can install @command{git send-email} wit= h > -@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. > =C2=A0 > -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. > =C2=A0 > =C2=A0@unnumberedsubsec Teams > =C2=A0@anchor{Teams} > @@ -1448,7 +1500,7 @@ You can run the following command to have the > @code{Mentors} team put in > =C2=A0CC of a patch series: > =C2=A0 > =C2=A0@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 > =C2=A0@end example > =C2=A0 > =C2=A0The appropriate team or teams can also be inferred from the modifie= d > @@ -1457,7 +1509,7 @@ current Git repository to review, you can run: > =C2=A0 > =C2=A0@example > =C2=A0$ 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 > =C2=A0@end example > =C2=A0 > =C2=A0@node Tracking Bugs and Patches >=20 > base-commit: 88746cd80bc56212ae7922c0fa1cd9a18e44c3bb Also, this series makes it look as though we're only considering multi- patch series. Is the simple case of a single patch still covered? I'd perhaps organize this along these lines: - Sending a single patch - Notifying your senpais via etc/teams - Sending a multi-patch series Please don't take these headings too literally ;) Cheers From debbugs-submit-bounces@debbugs.gnu.org Sat Oct 22 07:31:08 2022 Received: (at 58648) by debbugs.gnu.org; 22 Oct 2022 11:31:08 +0000 Received: from localhost ([127.0.0.1]:39828 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1omCia-0003tF-Bq for submit@debbugs.gnu.org; Sat, 22 Oct 2022 07:31:08 -0400 Received: from knopi.disroot.org ([178.21.23.139]:59570) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1omCiV-0003sr-6k for 58648@debbugs.gnu.org; Sat, 22 Oct 2022 07:31:06 -0400 Received: from localhost (localhost [127.0.0.1]) by disroot.org (Postfix) with ESMTP id 4C0694E704; Sat, 22 Oct 2022 13:31:01 +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 ESMTP id 6nNNl4FaofnS; Sat, 22 Oct 2022 13:31:00 +0200 (CEST) Mime-Version: 1.0 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=disroot.org; s=mail; t=1666438260; bh=CAFs1FC1LXl+r+as4qPIEMrDsbrxj74MtLbn/8SKv4A=; h=Date:Subject:From:To:References:In-Reply-To; b=kNRYoYZh00KbLyLt1nxQO/+OPl6RR+cZYJNo5K+hvMc0t+/0QQPxF5+E6uB3JglcM 2KHh+UJjTlJ733o1QyLMg1X77IbreJIMgwCDPyYkPP3+0sp37luQ6ilbzuYyF8ViuB O7ZG+jhTnSKwDXACbMpMCw1RQdscMrDXVPdcoxM8e9rSFecXJcTIqXniWWZ3AWdDPv nMr5ioqSRq0eqA7CbKbdHcRw79N4yZf0++4gyYZLRLxqu421UvLxk+pc8tqGJFOWe8 SalSGNBNR2kZZ5PAoNLFLwjtjSkW8eqprWieQ4rwFhWkALz4bmbfjUB9rFoabsus3T dhxcC4hcxHH4Q== Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset=UTF-8 Date: Sat, 22 Oct 2022 12:30:59 +0100 Message-Id: Subject: Re: [PATCH v2] doc: contributing: Expand "Sending a Patch Series". From: "(" To: "Liliana Marie Prikler" , <58648@debbugs.gnu.org> References: <20221020141349.4780-1-paren@disroot.org> <9c9a4925aedab67b99f928084ecc7d46fda75f20.camel@gmail.com> In-Reply-To: <9c9a4925aedab67b99f928084ecc7d46fda75f20.camel@gmail.com> X-Spam-Score: 1.3 (+) X-Spam-Report: Spam detection software, running on the system "debbugs.gnu.org", has NOT identified this incoming email as spam. The original message has been attached to this so you can view it or label similar future email. If you have any questions, see the administrator of that system for details. Content preview: On Sat Oct 22, 2022 at 12:21 PM BST, Liliana Marie Prikler wrote: > Also, this series makes it look as though we're only considering multi- > patch series. Is the simple case of a single patch still c [...] Content analysis details: (1.3 points, 10.0 required) pts rule name description ---- ---------------------- -------------------------------------------------- 1.3 FROM_ONE_CHAR Bogus FROM name -0.0 SPF_PASS SPF: sender matches SPF record 0.0 SPF_HELO_NONE SPF: HELO does not publish an SPF Record X-Debbugs-Envelope-To: 58648 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: 0.3 (/) On Sat Oct 22, 2022 at 12:21 PM BST, Liliana Marie Prikler wrote: > Also, this series makes it look as though we're only considering multi- > patch series. Is the simple case of a single patch still covered? $ git format-patch -1 --cover-letter --base=3Dauto -o outgoing works fine for a single patch. In my opinion, you should send a cover letter for every set of patches, even if the set only contains a single patch. -- ( From debbugs-submit-bounces@debbugs.gnu.org Sat Oct 22 08:20:13 2022 Received: (at 58648) by debbugs.gnu.org; 22 Oct 2022 12:20:13 +0000 Received: from localhost ([127.0.0.1]:39854 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1omDU5-000541-9h for submit@debbugs.gnu.org; Sat, 22 Oct 2022 08:20:13 -0400 Received: from mail-ed1-f65.google.com ([209.85.208.65]:40589) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1omDU2-00053k-7J for 58648@debbugs.gnu.org; Sat, 22 Oct 2022 08:20:11 -0400 Received: by mail-ed1-f65.google.com with SMTP id r14so15148980edc.7 for <58648@debbugs.gnu.org>; Sat, 22 Oct 2022 05:20:10 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=mime-version:user-agent:content-transfer-encoding:references :in-reply-to:date:to:from:subject:message-id:from:to:cc:subject:date :message-id:reply-to; bh=LxdFefb8vGXrydknnrtrbXqzTBvdvy4mbC2hJ2yfd2k=; b=KqWc21yy6mPu7CSkMPIT8NSQr9B9HT2t2FEC9O3+CAE0hliF+wyzR4M1igZlOFFH8R RufEsYmtzCeyr/kDWZmxiwSCHKniG/pDpt421IOkkAUZTsoPUNzZZRGZhnA/1uzC70YO IKsGzcT+HG/V3LfKtcKO9ZtmflAuI54B+mvZvWS3udmikI3KHguvz1LCB57wSexjrkPx xL3hAO6R2hoER2vDTcn7QeWB/8nvezGtMUbQmMX3A9QRAWlRUXcUMKOQ3A3jvqSm9qx+ W92r/QUxj6ZILCLxabUS6quRkZylb7AHn85/FEIytJnIhx6MlJnDm5YGyvS43AUJQj1u Rw9w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=mime-version:user-agent:content-transfer-encoding:references :in-reply-to:date:to:from:subject:message-id:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=LxdFefb8vGXrydknnrtrbXqzTBvdvy4mbC2hJ2yfd2k=; b=vZGSKl5JfHdpNd8Rn5J69EBft53GWFBGvUDsI+yPirOex+7UjuMrStoXHrpS1KgBov qVrNOZbwlTuRBd/fnOdxHzbx5NxtvcshiOw0+k7OWDJLGD2P8sY1S/alcr95tcNXcQXG MgF7FjiDJ4wEET5TjBcZBb2pvc11jJIwA9yc9ZlyjiBP0Y8OIK4P3EPHo2DWQIAwFBwT z1k1b8Rt4fr4WSom0QKvqqwTC2K8raoJG+yHJHHUlG3MJX5+tcaVskcDwkXB6eNgRjz1 8cJgDOJt+0QF4Pd4lXFHlH8R3X0mZGztQ3bY6J2rumPk0ccVLDlhw4761Fpvqe4aL2y7 3GgA== X-Gm-Message-State: ACrzQf0llsh0uk8KxRbBN4DZzHGrpdaOks+GfRub4y/5eZr896QAyVNw SC72aM9FvbJGJuMhN3GFsTE= X-Google-Smtp-Source: AMsMyM6L324hnntop2PeiMSXzQrhTD4fZeslbfBFj/PiD/8c37mn1fY83e288w634kv5o++HLDHreQ== X-Received: by 2002:aa7:dc10:0:b0:440:b446:c0cc with SMTP id b16-20020aa7dc10000000b00440b446c0ccmr21772262edu.34.1666441204115; Sat, 22 Oct 2022 05:20:04 -0700 (PDT) Received: from lumine.fritz.box (85-127-52-93.dsl.dynamic.surfer.at. [85.127.52.93]) by smtp.gmail.com with ESMTPSA id kx21-20020a170907775500b0078c468bd604sm12912281ejc.57.2022.10.22.05.20.03 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 22 Oct 2022 05:20:03 -0700 (PDT) Message-ID: Subject: Re: [PATCH v2] doc: contributing: Expand "Sending a Patch Series". From: Liliana Marie Prikler To: "(" , 58648@debbugs.gnu.org Date: Sat, 22 Oct 2022 14:20:02 +0200 In-Reply-To: References: <20221020141349.4780-1-paren@disroot.org> <9c9a4925aedab67b99f928084ecc7d46fda75f20.camel@gmail.com> Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable User-Agent: Evolution 3.46.0 MIME-Version: 1.0 X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 58648 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) Am Samstag, dem 22.10.2022 um 12:30 +0100 schrieb (: > On Sat Oct 22, 2022 at 12:21 PM BST, Liliana Marie Prikler wrote: > > Also, this series makes it look as though we're only considering > > multi- > > patch series.=C2=A0 Is the simple case of a single patch still covered? >=20 > $ git format-patch -1 --cover-letter --base=3Dauto -o outgoing >=20 > works fine for a single patch.=C2=A0 In my opinion, you should send a > cover letter for every set of patches, even if the set only contains > a single patch. >=20 > =C2=A0=C2=A0=C2=A0 -- ( I kindly disagree. With single patches, you can add notes below the dashed line and send less bytes over avian carriers. From debbugs-submit-bounces@debbugs.gnu.org Tue Oct 25 14:54:37 2022 Received: (at 58648) by debbugs.gnu.org; 25 Oct 2022 18:54:37 +0000 Received: from localhost ([127.0.0.1]:52269 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1onP4O-00011J-RK for submit@debbugs.gnu.org; Tue, 25 Oct 2022 14:54:37 -0400 Received: from knopi.disroot.org ([178.21.23.139]:40890) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1onP4M-000117-Do for 58648@debbugs.gnu.org; Tue, 25 Oct 2022 14:54:35 -0400 Received: from localhost (localhost [127.0.0.1]) by disroot.org (Postfix) with ESMTP id 17DB14ECF4; Tue, 25 Oct 2022 20:54:33 +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 23l8221nkThz; Tue, 25 Oct 2022 20:54:31 +0200 (CEST) From: "(" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=disroot.org; s=mail; t=1666723381; bh=36LhRwBWHolFXj9rihido6o62mm4kMh8z2xKbLmPmQk=; h=From:To:Cc:Subject:Date; b=Py+Ft94njtutHmsuiXeAWB8Km/ahnSQOciDo6zZexokPjtx8L10uzcuYtlt3MKyUU ToMaOym4M/S0RATcJ/B1eFKCdmgfkRmwrsfhi3WvclumJwZ694yBP2+ATPPhP39R9o 0cbxztXX360tVaKkRPmI4XGlYiSv8Y04nj8xX6fjObBUCdQ5n++RKL4qezTm7LON4/ VRtkJZ9Njj0YLi/UNRM3mIjTrdjbDyr/D2yy3xNiR8s6IqgcobFhVL9tpaepaXNDNB VFEnfWSGzba/cj+aXOAVpjLJAB6qk55QgzqooPp2aV+8zizKEw0+almETZeT/4cHrU U9HFIghq2ggnQ== To: 58648@debbugs.gnu.org Subject: [PATCH v3] doc: contributing: Expand "Sending a Patch Series". Date: Tue, 25 Oct 2022 19:42:51 +0100 Message-Id: <20221025184251.8388-1-paren@disroot.org> Mime-Version: 1.0 Content-Transfer-Encoding: 8bit X-Spam-Score: 1.3 (+) X-Spam-Report: Spam detection software, running on the system "debbugs.gnu.org", has NOT identified this incoming email as spam. The original message has been attached to this so you can view it or label similar future email. If you have any questions, see the administrator of that system for details. Content preview: * doc/contributing.texi: Expand on sending patches and using git send-email. --- doc/contributing.texi | 173 +++++++++++++++++++++++++++++++++--------- 1 file changed, 136 insertions(+), 37 deletions( [...] Content analysis details: (1.3 points, 10.0 required) pts rule name description ---- ---------------------- -------------------------------------------------- 1.3 FROM_ONE_CHAR Bogus FROM name -0.0 SPF_PASS SPF: sender matches SPF record 0.0 SPF_HELO_NONE SPF: HELO does not publish an SPF Record X-Debbugs-Envelope-To: 58648 Cc: "\(" X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: 0.3 (/) * doc/contributing.texi: Expand on sending patches and using git send-email. --- doc/contributing.texi | 173 +++++++++++++++++++++++++++++++++--------- 1 file changed, 136 insertions(+), 37 deletions(-) diff --git a/doc/contributing.texi b/doc/contributing.texi index 4b1eed1cb1..9770018521 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -1138,8 +1138,8 @@ This mailing list is backed by a Debbugs instance, which allows us to keep track of submissions (@pxref{Tracking Bugs and Patches}). Each message sent to that mailing list gets a new tracking number assigned; people can then follow up on the submission by sending email to -@code{@var{NNN}@@debbugs.gnu.org}, where @var{NNN} is the tracking -number (@pxref{Sending a Patch Series}). +@code{@var{ISSUE_NUMBER}@@debbugs.gnu.org}, where @var{ISSUE_NUMBER} is +the tracking number (@pxref{Sending a Patch Series}). Please write commit logs in the ChangeLog format (@pxref{Change Logs,,, standards, GNU Coding Standards}); you can check the commit history for @@ -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 @@ -1367,7 +1346,7 @@ acknowledgement with the assigned tracking number. Future acknowledgements should not be delayed. When a bug is resolved, please close the thread by sending an email to -@email{@var{NNN}-done@@debbugs.gnu.org}. +@email{@var{ISSUE_NUMBER}-done@@debbugs.gnu.org}. @node Configuring Git @subsection Configuring Git @@ -1409,19 +1388,139 @@ git config --local sendemail.thread no @anchor{Sending a Patch Series} @cindex patch series @cindex @code{git send-email} +@cindex @code{git format-patch} + +@unnumberedsubsubsec Single Patches +@anchor{Single Patches} +The @command{git send-email} command is the best way to send both single +patches and patch series (@pxref{Multiple Patches}) to the Guix mailing +list. Sending patches as email attachments may make them difficult to +review in some mail clients, and @command{git diff} does not store commit +metadata. + +@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 + +The following command will create a patch email from the latest commit, +open it in your @var{EDITOR} or @var{VISUAL} for editing, and send it to +the Guix mailing list to be reviewed and merged: + +@example +$ git send-email -1 -a --base=auto --to=guix-patches@@gnu.org +@end example + +@quotation Tip +To add a prefix to the subject of your patch, you may use the +@option{--subject-prefix} option. The Guix project uses this to +specify that the patch is intended for a branch or repository +other than the @code{master} branch of +@url{https://git.savannah.gnu.org/cgit/guix.git}. + +@example +git send-email -1 -a --base=auto \ + --subject-prefix='PATCH core-updates' \ + --to=guix-patches@@gnu.org +@end example +@end quotation -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 +The patch email contains a three-dash separator line after the commit +message. You may ``annotate'' the patch with explanatory text by adding +it under this line. If you do not wish to annotate the email, you may +drop the @option{-a} flag (which is short for @option{--annotate}). + +The @option{--base=auto} flag automatically adds a note at the bottom +of the patch of the commit it was based on, making it easier for +maintainers to rebase and merge your patch. + +If you need to send a revised patch, don't resend it like this or send +a ``fix'' patch to be applied on top of the last one; instead, use +@command{git commit -a} or @url{https://git-rebase.io, @command{git rebase}} +to modify the commit, and use the @email{@var{ISSUE_NUMBER}@@debbugs.gnu.org} +address and the @option{-v} flag with @command{git send-email}. + +@example +$ git commit -a +$ git send-email -1 -a --base=auto -v @var{REVISION} \ + --to=@var{ISSUE_NUMBER}@@debbugs.gnu.org +@end example + +You can find out @var{ISSUE_NUMBER} either by searching on the mumi +interface at @url{issues.guix.gnu.org} for the name of your patch or +reading the acknowledgement email sent automatically by Debbugs in +reply to incoming bugs and patches, which contains the bug number. + +@unnumberedsubsubsec Notifying Teams +@anchor{Notifying Teams} +@cindex teams +The @file{etc/teams.scm} script may be used to notify all those who +may be interested in your patch of its existence (@pxref{Teams}). +Use @command{etc/teams.scm list-teams} to display all the teams, +decide which team(s) your patch relates to, and use +@command{etc/teams.scm cc} to output various @command{git send-email} +flags which will notify the appropriate team members, or use +@command{etc/teams.scm cc-members} to detect the appropriate teams +automatically. + +@unnumberedsubsubsec Multiple Patches +@anchor{Multiple Patches} +@cindex cover letter +While @command{git send-email} alone will suffice for a single +patch, an unfortunate flaw in Debbugs means you need to be more +careful when sending multiple patches: if you send them all to the +@email{guix-patches@@gnu.org} address, a new issue will be created +for each patch! + +When sending a series of patches, it's best to send a Git ``cover +letter'' first, to give reviewers an overview of the patch series. +We can create a directory called @file{outgoing} containing both +our patch series and a cover letter called @file{0000-cover-letter.patch} +with @command{git format-patch}. + +@example +$ git format-patch -@var{NUMBER_COMMITS} -o outgoing \ + --cover-letter --base=auto +@end example + +We can now send @emph{just} the cover letter to the +@email{guix-patches@@gnu.org} address, which will create an issue +that we can send the rest of the patches to. + +@example +$ git send-email outgoing/0000-cover-letter.patch -a \ + --to=guix-patches@@debbugs.gnu.org \ + $(etc/teams.scm cc-members ...) +$ rm outgoing/0000-cover-letter.patch # we don't want to resend it! +@end example + +Ensure you edit the email to add an appropriate subject line and +blurb before sending it. Note the automatically generated shortlog +and diffstat below the blurb. + +Once the Debbugs mailer has replied to your cover letter email, you +can send the actual patches to the newly-created issue address. + +@example +$ git send-email outgoing/*.patch \ + --to=@var{ISSUE_NUMBER}@@debbugs.gnu.org \ + $(etc/teams.scm cc-members ...) +$ rm -rf outgoing # we don't need these anymore +@end example + +Thankfully, this @command{git format-patch} dance is not necessary +to send an amended patch series, since an issue already exists for +the patchset. + +@example +$ git send-email -@var{NUMBER_COMMITS} \ + -v@var{REVISION} --base=auto \ + --to @var{ISSUE_NUMBER}@@debbugs.gnu.org +@end example -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 +1547,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 +1556,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 base-commit: 88746cd80bc56212ae7922c0fa1cd9a18e44c3bb -- 2.38.0 From debbugs-submit-bounces@debbugs.gnu.org Tue Oct 25 15:18:18 2022 Received: (at 58648) by debbugs.gnu.org; 25 Oct 2022 19:18:19 +0000 Received: from localhost ([127.0.0.1]:52316 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1onPRK-0003ob-34 for submit@debbugs.gnu.org; Tue, 25 Oct 2022 15:18:18 -0400 Received: from mail-ej1-f67.google.com ([209.85.218.67]:44741) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1onPRG-0003oF-Ng for 58648@debbugs.gnu.org; Tue, 25 Oct 2022 15:18:17 -0400 Received: by mail-ej1-f67.google.com with SMTP id n12so9892881eja.11 for <58648@debbugs.gnu.org>; Tue, 25 Oct 2022 12:18:14 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=mime-version:user-agent:content-transfer-encoding:references :in-reply-to:date:cc:to:from:subject:message-id:from:to:cc:subject :date:message-id:reply-to; bh=6O9pzXVFLaL5uPMVah2135wmDzvTX1S8f2PnQGry0gg=; b=Aj5aaQIbwehHMl8ctNpb9dV6WxSw0WxlLR3+6vH34lalI7ClrGLMHeMJThCEMmQRRr jolbXnj4iAknE+v5U/8mvuJh4HUJ1VCIvxUnZK5fCS1CHsSZFeaSO7y/N1gjqmQ6/AUo WyvXIA97V/2SMuauudIJtkAHaK9os0oaS/2k52nKie8sp7i8TJlxZGWK7iCWRhAbEuBC p0XWwrK5I8y2nmfGqps19h7cl9heZmhCNLZ2QXdCId5+bfUe08R6a2fiZmEBq+oA9zx5 oYRCYDKWVuHMlPzj3LyxnISAkt76lxOs8y5IWKvrJHYVHz7OIpISGVNOUMwDMAjK0Usx ZVog== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=mime-version:user-agent:content-transfer-encoding:references :in-reply-to:date:cc:to:from:subject:message-id:x-gm-message-state :from:to:cc:subject:date:message-id:reply-to; bh=6O9pzXVFLaL5uPMVah2135wmDzvTX1S8f2PnQGry0gg=; b=jJQhKKdtkE5PW2SYlUF8Yn7PCIXt3DsN6wqkbk/8mL+APR0UBXcp5Tt1CYOMn910Mi j9x7XS8bvYSFDEmWyJN/YNbg213KYcfnnOPNf/iSdvjtEu6Nqx8N7skZ6hTc+kF4ZSIK KbxNf7V65/sJRsjDA1TvJM7tSPPOiD/cL6HcdqZFNF4CcQ91oLFkK/+irJdiG3LpdHcI LOLoPz00Qe75wlFzdhoC5fAKcnAPZD4mHgwPQzhr8raGC27LUS0Pr5HsDJxr7bHXO03Y NcydFTojc0HqMPvFLd8FUn8Z9RclEk4OKid6bTsp7/KdI2m4ngSAnqrXt48RXy32OM0U RlKg== X-Gm-Message-State: ACrzQf119RqXdb3Zpks6IHDczqdHVe9xPMaCPk6e364Q6RZLKqR5ya/4 bDlul8gHHB8uIlLndab1UaU= X-Google-Smtp-Source: AMsMyM668N9cC9sqU2lgvzPbT60QCmK76c4Fw+/fsaSiHRoeZoOemHFpOVYbictueCMW1K67WIxEuQ== X-Received: by 2002:a17:907:7e95:b0:78d:e9cf:82c7 with SMTP id qb21-20020a1709077e9500b0078de9cf82c7mr34724475ejc.724.1666725488772; Tue, 25 Oct 2022 12:18:08 -0700 (PDT) Received: from lumine.fritz.box (85-127-52-93.dsl.dynamic.surfer.at. [85.127.52.93]) by smtp.gmail.com with ESMTPSA id b12-20020a1709063f8c00b0078d4e39d87esm1790121ejj.225.2022.10.25.12.18.08 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 25 Oct 2022 12:18:08 -0700 (PDT) Message-ID: <37b48f864a5e0ab4823a4441aa831bf2abb02fe1.camel@gmail.com> Subject: Re: [PATCH v3] doc: contributing: Expand "Sending a Patch Series". From: Liliana Marie Prikler To: "(" , 58648@debbugs.gnu.org Date: Tue, 25 Oct 2022 21:18:07 +0200 In-Reply-To: <20221025184251.8388-1-paren@disroot.org> References: <20221025184251.8388-1-paren@disroot.org> Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable User-Agent: Evolution 3.46.0 MIME-Version: 1.0 X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 58648 Cc: zimoun X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) Am Dienstag, dem 25.10.2022 um 19:42 +0100 schrieb (: > * doc/contributing.texi: Expand on sending patches and using > =C2=A0 git send-email. > --- > =C2=A0doc/contributing.texi | 173 +++++++++++++++++++++++++++++++++------= - > -- > =C2=A01 file changed, 136 insertions(+), 37 deletions(-) >=20 > diff --git a/doc/contributing.texi b/doc/contributing.texi > index 4b1eed1cb1..9770018521 100644 > --- a/doc/contributing.texi > +++ b/doc/contributing.texi > @@ -1138,8 +1138,8 @@ This mailing list is backed by a Debbugs > instance, which allows us to > =C2=A0keep track of submissions (@pxref{Tracking Bugs and Patches}).=C2= =A0 Each > =C2=A0message sent to that mailing list gets a new tracking number > assigned; > =C2=A0people can then follow up on the submission by sending email to > -@code{@var{NNN}@@debbugs.gnu.org}, where @var{NNN} is the tracking > -number (@pxref{Sending a Patch Series}). > +@code{@var{ISSUE_NUMBER}@@debbugs.gnu.org}, where @var{ISSUE_NUMBER} > is > +the tracking number (@pxref{Sending a Patch Series}). > =C2=A0 > =C2=A0Please write commit logs in the ChangeLog format (@pxref{Change > Logs,,, > =C2=A0standards, GNU Coding Standards}); you can check the commit history > for > @@ -1149,15 +1149,6 @@ Before submitting a patch that adds or > modifies a package definition, > =C2=A0please run through this check list: > =C2=A0 > =C2=A0@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=3D}, perhaps > with > -the value @code{auto}.=C2=A0 This option adds a note to the patch statin= g > -which commit the patch is based on.=C2=A0 This helps reviewers understan= d > how > -to apply and review your patches. > - > =C2=A0@item > =C2=A0If the authors of the packaged software provide a cryptographic > =C2=A0signature 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 > =C2=A0@code{master}, say @code{core-updates}, specify it in the subject > like > =C2=A0@samp{[PATCH core-updates] @dots{}}. > =C2=A0 > -@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=3D'PATCH core-updates' \ > -=C2=A0 --to=3Dguix-patches@@gnu.org -1 > -@end example > -For more information, run @samp{man git-format-patch} and @samp{man > -git-send-email}. > -@end quotation > - > =C2=A0You may use your email client or the @command{git send-email} > command > =C2=A0(@pxref{Sending a Patch Series}).=C2=A0 We prefer to get patches in= plain > =C2=A0text messages, either inline or as MIME attachments.=C2=A0 You are > advised to > @@ -1367,7 +1346,7 @@ acknowledgement with the assigned tracking > number. Future acknowledgements > =C2=A0should not be delayed. > =C2=A0 > =C2=A0When a bug is resolved, please close the thread by sending an email > to > -@email{@var{NNN}-done@@debbugs.gnu.org}. > +@email{@var{ISSUE_NUMBER}-done@@debbugs.gnu.org}. > =C2=A0 > =C2=A0@node Configuring Git > =C2=A0@subsection Configuring Git > @@ -1409,19 +1388,139 @@ git config --local sendemail.thread no > =C2=A0@anchor{Sending a Patch Series} > =C2=A0@cindex patch series > =C2=A0@cindex @code{git send-email} > +@cindex @code{git format-patch} > + > +@unnumberedsubsubsec Single Patches > +@anchor{Single Patches} > +The @command{git send-email} command is the best way to send both > single > +patches and patch series (@pxref{Multiple Patches}) to the Guix > mailing > +list.=C2=A0 Sending patches as email attachments may make them difficult > to > +review in some mail clients, and @command{git diff} does not store > commit > +metadata. > + > +@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 > + > +The following command will create a patch email from the latest > commit, > +open it in your @var{EDITOR} or @var{VISUAL} for editing, and send > it to > +the Guix mailing list to be reviewed and merged: > + > +@example > +$ git send-email -1 -a --base=3Dauto --to=3Dguix-patches@@gnu.org > +@end example > + > +@quotation Tip > +To add a prefix to the subject of your patch, you may use the > +@option{--subject-prefix} option.=C2=A0 The Guix project uses this to > +specify that the patch is intended for a branch or repository > +other than the @code{master} branch of > +@url{https://git.savannah.gnu.org/cgit/guix.git}. > + > +@example > +git send-email -1 -a --base=3Dauto \ > +=C2=A0=C2=A0=C2=A0 --subject-prefix=3D'PATCH core-updates' \ > +=C2=A0=C2=A0=C2=A0 --to=3Dguix-patches@@gnu.org > +@end example > +@end quotation > =C2=A0 > -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.=C2=A0 See > -@uref{https://debbugs.gnu.org/Advanced.html, the Debbugs > documentation} > -for more information.=C2=A0 You can install @command{git send-email} wit= h > -@command{guix install git:send-email}. > -@c Debbugs bug: https://debbugs.gnu.org/db/15/15361.html > +The patch email contains a three-dash separator line after the > commit > +message.=C2=A0 You may ``annotate'' the patch with explanatory text by > adding > +it under this line.=C2=A0 If you do not wish to annotate the email, you > may > +drop the @option{-a} flag (which is short for @option{--annotate}). > + > +The @option{--base=3Dauto} flag automatically adds a note at the > bottom > +of the patch of the commit it was based on, making it easier for > +maintainers to rebase and merge your patch. > + > +If you need to send a revised patch, don't resend it like this or > send > +a ``fix'' patch to be applied on top of the last one; instead, use > +@command{git commit -a} or @url{https://git-rebase.io, @command{git > rebase}} > +to modify the commit, and use the > @email{@var{ISSUE_NUMBER}@@debbugs.gnu.org} > +address and the @option{-v} flag with @command{git send-email}. > + > +@example > +$ git commit -a > +$ git send-email -1 -a --base=3Dauto -v @var{REVISION} \ > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 --to=3D@var{ISSUE_NUMBER}@@debbugs.gnu.or= g > +@end example > + > +You can find out @var{ISSUE_NUMBER} either by searching on the mumi > +interface at @url{issues.guix.gnu.org} for the name of your patch or > +reading the acknowledgement email sent automatically by Debbugs in > +reply to incoming bugs and patches, which contains the bug number. > + > +@unnumberedsubsubsec Notifying Teams > +@anchor{Notifying Teams} > +@cindex teams > +The @file{etc/teams.scm} script may be used to notify all those who > +may be interested in your patch of its existence (@pxref{Teams}). > +Use @command{etc/teams.scm list-teams} to display all the teams, > +decide which team(s) your patch relates to, and use > +@command{etc/teams.scm cc} to output various @command{git send- > email} > +flags which will notify the appropriate team members, or use > +@command{etc/teams.scm cc-members} to detect the appropriate teams > +automatically. > + > +@unnumberedsubsubsec Multiple Patches > +@anchor{Multiple Patches} > +@cindex cover letter > +While @command{git send-email} alone will suffice for a single > +patch, an unfortunate flaw in Debbugs means you need to be more > +careful when sending multiple patches: if you send them all to the > +@email{guix-patches@@gnu.org} address, a new issue will be created > +for each patch! > + > +When sending a series of patches, it's best to send a Git ``cover > +letter'' first, to give reviewers an overview of the patch series. > +We can create a directory called @file{outgoing} containing both > +our patch series and a cover letter called @file{0000-cover- > letter.patch} > +with @command{git format-patch}. > + > +@example > +$ git format-patch -@var{NUMBER_COMMITS} -o outgoing \ > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 --cover-letter --base=3Dauto > +@end example > + > +We can now send @emph{just} the cover letter to the > +@email{guix-patches@@gnu.org} address, which will create an issue > +that we can send the rest of the patches to. > + > +@example > +$ git send-email outgoing/0000-cover-letter.patch -a \ > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 --to=3Dguix-patches@@debbugs.gnu.org \ > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 $(etc/teams.scm cc-members ...) > +$ rm outgoing/0000-cover-letter.patch # we don't want to resend it! > +@end example > + > +Ensure you edit the email to add an appropriate subject line and > +blurb before sending it.=C2=A0 Note the automatically generated shortlog > +and diffstat below the blurb. > + > +Once the Debbugs mailer has replied to your cover letter email, you > +can send the actual patches to the newly-created issue address. > + > +@example > +$ git send-email outgoing/*.patch \ > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 --to=3D@var{ISSUE_NUMBER}@@debbugs.gnu.or= g \ > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 $(etc/teams.scm cc-members ...) > +$ rm -rf outgoing # we don't need these anymore > +@end example > + > +Thankfully, this @command{git format-patch} dance is not necessary > +to send an amended patch series, since an issue already exists for > +the patchset. > + > +@example > +$ git send-email -@var{NUMBER_COMMITS} \ > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 -v@var{REVISION} --base=3Dauto \ > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 --to @var{ISSUE_NUMBER}@@debbugs.gnu.org > +@end example > =C2=A0 > -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. > =C2=A0 > =C2=A0@unnumberedsubsec Teams > =C2=A0@anchor{Teams} > @@ -1448,7 +1547,7 @@ You can run the following command to have the > @code{Mentors} team put in > =C2=A0CC of a patch series: > =C2=A0 > =C2=A0@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 > =C2=A0@end example > =C2=A0 > =C2=A0The appropriate team or teams can also be inferred from the modifie= d > @@ -1457,7 +1556,7 @@ current Git repository to review, you can run: > =C2=A0 > =C2=A0@example > =C2=A0$ 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 > =C2=A0@end example > =C2=A0 > =C2=A0@node Tracking Bugs and Patches >=20 > base-commit: 88746cd80bc56212ae7922c0fa1cd9a18e44c3bb LGTM. Also CC'd zimoun From debbugs-submit-bounces@debbugs.gnu.org Tue Oct 25 15:27:13 2022 Received: (at 58648) by debbugs.gnu.org; 25 Oct 2022 19:27:13 +0000 Received: from localhost ([127.0.0.1]:52356 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1onPZx-00043D-LP for submit@debbugs.gnu.org; Tue, 25 Oct 2022 15:27:13 -0400 Received: from knopi.disroot.org ([178.21.23.139]:50168) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1onPZv-000433-52 for 58648@debbugs.gnu.org; Tue, 25 Oct 2022 15:27:11 -0400 Received: from localhost (localhost [127.0.0.1]) by disroot.org (Postfix) with ESMTP id 735A94EC1D; Tue, 25 Oct 2022 21:27:09 +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 Ybuf73IdLwh8; Tue, 25 Oct 2022 21:27:08 +0200 (CEST) Mime-Version: 1.0 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=disroot.org; s=mail; t=1666725815; bh=G7denaMTKkloHdNrxzlhPbddb2HEAKIXi/HJ9lBKKhs=; h=Date:Cc:Subject:From:To:References:In-Reply-To; b=gex0ref7n79dpm457fRutpvmJtAcsRLJLgiAAdYCr1TtVyUX/dTl+d0JPpKm1jLyy rJ8jFCUqbMTvFwSNDOSo4bP+pAe1YKZnxomc7HP5zqsqzEqS9GnQ4uNWSyftG1ysh9 CpfEJN0z5FWjWZDL2t6VqyLuxWHz/N0j5yIyWWkNQ/c78RFQcKqRd24BWz3HHTjkpp DtbqsMp7wqZxkWoC8PXBupQJcXgxOJ/Vjqcuff6nM4zDd1msFUw821OBAUqhOPXg71 Y4N3taVLbgr/cPsnyQsKlwDex/rXEmcDZXaYgut4tQX9Ew8SR96OXeXfj+uaZ3Xzhl EoIDr9P/HnMUQ== Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset=UTF-8 Date: Tue, 25 Oct 2022 20:23:33 +0100 Message-Id: Subject: Re: [PATCH v3] doc: contributing: Expand "Sending a Patch Series". From: "(" To: "Liliana Marie Prikler" , <58648@debbugs.gnu.org> References: <20221025184251.8388-1-paren@disroot.org> <37b48f864a5e0ab4823a4441aa831bf2abb02fe1.camel@gmail.com> In-Reply-To: <37b48f864a5e0ab4823a4441aa831bf2abb02fe1.camel@gmail.com> X-Spam-Score: 1.3 (+) X-Spam-Report: Spam detection software, running on the system "debbugs.gnu.org", has NOT identified this incoming email as spam. The original message has been attached to this so you can view it or label similar future email. If you have any questions, see the administrator of that system for details. Content preview: Heya, On Tue Oct 25, 2022 at 8:18 PM BST, Liliana Marie Prikler wrote: > LGTM. \o/ Content analysis details: (1.3 points, 10.0 required) pts rule name description ---- ---------------------- -------------------------------------------------- 1.3 FROM_ONE_CHAR Bogus FROM name -0.0 SPF_PASS SPF: sender matches SPF record 0.0 SPF_HELO_NONE SPF: HELO does not publish an SPF Record X-Debbugs-Envelope-To: 58648 Cc: zimoun X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: 0.3 (/) Heya, On Tue Oct 25, 2022 at 8:18 PM BST, Liliana Marie Prikler wrote: > LGTM. \o/ Thanks for the review! (Simon too :)) -- ( From debbugs-submit-bounces@debbugs.gnu.org Fri Oct 28 10:41:59 2022 Received: (at 58648) by debbugs.gnu.org; 28 Oct 2022 14:41:59 +0000 Received: from localhost ([127.0.0.1]:34051 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ooQYY-0003NA-PA for submit@debbugs.gnu.org; Fri, 28 Oct 2022 10:41:59 -0400 Received: from mail-wr1-f41.google.com ([209.85.221.41]:35395) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ooQYV-0003Mp-8r for 58648@debbugs.gnu.org; Fri, 28 Oct 2022 10:41:57 -0400 Received: by mail-wr1-f41.google.com with SMTP id l14so6896826wrw.2 for <58648@debbugs.gnu.org>; Fri, 28 Oct 2022 07:41:55 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:message-id:date:references :in-reply-to:subject:to:from:from:to:cc:subject:date:message-id :reply-to; bh=CNkKNyDRG3jJVFFeiM1qrPQ7wRWpskpQQFD24IkBMHo=; b=d40c/gOkr60E6EiQRYdAGThzTQey21w22Zd4wpasHJLtCgHKaHkFQYE8r8tBrZBifV ZJ9Xb1s0/52Ygll2heNdggcpnKtcv3QvkXErqvWQGA6pQ24wTCwhsEa//o+iRN+WyWyL F/ksr/1GC8Bpxo9ENQa27did+lWYxxln4rdDRjTYNd4HYrUiuF8DXGmqA7QRZ/igU01t cr8sJWcEtrTiINKIk7tlJhjqWaTAFadgxweSxBJXpw8w6M4/MFEfxR5K2DizBmRBHKF3 FcClUreXJJlExHtE98F47uhwuo5KaPCrWzimFqhr+p/QU+sVcaLVisxU4tLbmEezKVyL CIyg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:message-id:date:references :in-reply-to:subject:to:from:x-gm-message-state:from:to:cc:subject :date:message-id:reply-to; bh=CNkKNyDRG3jJVFFeiM1qrPQ7wRWpskpQQFD24IkBMHo=; b=GUG8bFfpLrkoWOKipSJtA8HmpU1S76gJib3qSP375gcrg2r+PPRapCLC58cQpg8XDj szGqzXisBTqClG33Al0qFVh7UFCYAfda2KzgHZ+44MOKhe9SN+QA2NLZIsSw+PN9MKwF Zlh3x9fLg6ZBpZlqTfxiYzOleGI+QzBeQJ3kZ6auasrjCbJieH0meSDM6XXjoAAR7ZY0 eF/SpdXNNCUzPkJRHbsCf/wfPb5mh8NqL9uH5Yd63jA7je2JphYZXhaH9qcboM9fTI7c Y6J28p22VAztqmDEV21lOFKEj/wwQD3k5H2BKomU3uggTz8B2XikN7wfAuD4QOPYqS93 0AuA== X-Gm-Message-State: ACrzQf3rIjktlfNhQqyGzTABxMdAK/3FCSYRhXRHQKTyJYk4+Gkp1suI RVStiVpr5yvyGpqpzQfHbyaJUM6tPM4= X-Google-Smtp-Source: AMsMyM6JGLpqFVlYErBV22H+xoOlqCrcAVPxzVCU91K2k8lLDMDn7DrjEGy0aV9AbKFMMj9/h7GXxQ== X-Received: by 2002:a5d:544a:0:b0:236:77f4:6e15 with SMTP id w10-20020a5d544a000000b0023677f46e15mr15761824wrv.117.1666968109305; Fri, 28 Oct 2022 07:41:49 -0700 (PDT) Received: from pfiuh07 ([193.48.40.241]) by smtp.gmail.com with ESMTPSA id bh17-20020a05600c3d1100b003cf47fdead5sm4536628wmb.30.2022.10.28.07.41.48 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 28 Oct 2022 07:41:48 -0700 (PDT) From: zimoun To: Liliana Marie Prikler , "(" , 58648@debbugs.gnu.org Subject: Re: [bug#58648] [PATCH v3] doc: contributing: Expand "Sending a Patch Series". In-Reply-To: <37b48f864a5e0ab4823a4441aa831bf2abb02fe1.camel@gmail.com> References: <20221025184251.8388-1-paren@disroot.org> <37b48f864a5e0ab4823a4441aa831bf2abb02fe1.camel@gmail.com> Date: Fri, 28 Oct 2022 16:04:35 +0200 Message-ID: <877d0khwng.fsf@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 58648 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) Hi, On mar., 25 oct. 2022 at 21:18, Liliana Marie Prikler wrote: > Am Dienstag, dem 25.10.2022 um 19:42 +0100 schrieb (: >> * doc/contributing.texi: Expand on sending patches and using >> =C2=A0 git send-email. >> --- >> =C2=A0doc/contributing.texi | 173 +++++++++++++++++++++++++++++++++-----= -- >> -- >> =C2=A01 file changed, 136 insertions(+), 37 deletions(-) >>=20 >> diff --git a/doc/contributing.texi b/doc/contributing.texi >> index 4b1eed1cb1..9770018521 100644 >> --- a/doc/contributing.texi >> +++ b/doc/contributing.texi [...] > LGTM. Well, I do not find where I did a minor comment and I do not remember what it was. It means it was not so much important. And I can propose it later. :-) LGTM! Liliana, feel free to push. :-) Cheers, simon From debbugs-submit-bounces@debbugs.gnu.org Fri Oct 28 10:41:59 2022 Received: (at 58648) by debbugs.gnu.org; 28 Oct 2022 14:41:59 +0000 Received: from localhost ([127.0.0.1]:34053 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ooQYZ-0003NC-1r for submit@debbugs.gnu.org; Fri, 28 Oct 2022 10:41:59 -0400 Received: from mail-wr1-f53.google.com ([209.85.221.53]:44923) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ooQYW-0003Mr-LT for 58648@debbugs.gnu.org; Fri, 28 Oct 2022 10:41:57 -0400 Received: by mail-wr1-f53.google.com with SMTP id v1so6860282wrt.11 for <58648@debbugs.gnu.org>; Fri, 28 Oct 2022 07:41:56 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:message-id:date:references :in-reply-to:subject:to:from:from:to:cc:subject:date:message-id :reply-to; bh=RrWXD5IaG/qOVnezOm5VG8aQU0ymMO+fvJO9cDV14Zw=; b=nVo8DBe1ghNDp9UxaPju0OFZ4v14wBAEJlP95S7LFhjp+tIrFo3Z22HNMwCQvtBGLp 0pLgwHWqYH1XNUlbve7bWfq6fqicB2jHaz+XsvvD5G7U/XnR6TnCiQzb7kqT3Qq5QKGD 0RXtBsr5S+M65tlI2dH7ecsutVF1JgThUwPzeOGNRrI6GiO9zj+1h8Msm4lmM7AFjZnj 36nrP4SsTye7Nbda65QJWb0yWxxT6YnlB2Llm/qNoJLuY8ynpBv4UhFjncG3b6l9lzVm FDkP8lB8TiHyC55lp7csvkQtO2jg1tGkLroh5mLjA2DE4OXvyL1SiR0tJ6W/LYcixoVF h65Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:message-id:date:references :in-reply-to:subject:to:from:x-gm-message-state:from:to:cc:subject :date:message-id:reply-to; bh=RrWXD5IaG/qOVnezOm5VG8aQU0ymMO+fvJO9cDV14Zw=; b=wM8ewn+1/vJd91y5xguL04xpljvUSksFvponlHZ+zg31/Fw2nD6ClODnD/85UOCMXc W959d8cJ9HojPOM5KXkJL99GEOq3If/C04jAOl61/PaZDoviBjhriPKtXYIiU0JfbvJc Dqv2uA21EDmV8AP1+ugB0RYkMPh6sBpKm4q6dGZ6yNcbgo/rg2FKCMFFvJH+F973vETy JRxc4ueOUBvzErHDmjtQIqkdhX+E6ATIsAGAqmxooY7liQpzHlAwVu/41uJl5QzwVst4 NeiHP9Y2oOTnzEjMN05x3LG1lBekllFtt5N9L5E1DQeHcHFyeM64WUHPEdFD6ElklLN4 46QQ== X-Gm-Message-State: ACrzQf0Nvg+HL3aXp/CYg28vmsSoV2oesxXs4IJoyh8TmV8I+azxj+Cv h06PaTAdSpt06tfmUec9+/KB1oRkHXI= X-Google-Smtp-Source: AMsMyM7AOI+LNSbGGwStxP9iyVRaEiW2lVutMVC1bkVNBegNNU7ZtcdujG0UWL/oCVaihJM3q4eGSQ== X-Received: by 2002:a5d:6d0e:0:b0:236:8dd7:11b8 with SMTP id e14-20020a5d6d0e000000b002368dd711b8mr8954617wrq.76.1666968110942; Fri, 28 Oct 2022 07:41:50 -0700 (PDT) Received: from pfiuh07 ([193.48.40.241]) by smtp.gmail.com with ESMTPSA id k21-20020a05600c1c9500b003bfaba19a8fsm4874425wms.35.2022.10.28.07.41.50 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 28 Oct 2022 07:41:50 -0700 (PDT) From: zimoun To: Liliana Marie Prikler , "(" , 58648@debbugs.gnu.org Subject: Re: [bug#58648] [PATCH v2] doc: contributing: Expand "Sending a Patch Series". In-Reply-To: References: <20221020141349.4780-1-paren@disroot.org> <9c9a4925aedab67b99f928084ecc7d46fda75f20.camel@gmail.com> Date: Fri, 28 Oct 2022 16:41:42 +0200 Message-ID: <87v8o4ggd5.fsf@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 58648 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) Hi Liliana, On sam., 22 oct. 2022 at 14:20, Liliana Marie Prikler wrote: >> works fine for a single patch.=C2=A0 In my opinion, you should send a >> cover letter for every set of patches, even if the set only contains >> a single patch. > I kindly disagree. With single patches, you can add notes below the > dashed line and send less bytes over avian carriers. Well, the section is a recommendation for helping in contributions. Therefore, I also think it is a good idea to recommend to start by a cover letter even for single patch. It does not mean that some other workflows are not possible. :-) Cheers, simon From debbugs-submit-bounces@debbugs.gnu.org Fri Nov 18 08:47:12 2022 Received: (at control) by debbugs.gnu.org; 18 Nov 2022 13:47:12 +0000 Received: from localhost ([127.0.0.1]:35826 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ow1i4-00069x-Cr for submit@debbugs.gnu.org; Fri, 18 Nov 2022 08:47:12 -0500 Received: from eggs.gnu.org ([209.51.188.92]:39422) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ow1i2-00069h-Dx for control@debbugs.gnu.org; Fri, 18 Nov 2022 08:47:10 -0500 Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ow1hx-0003tq-7M for control@debbugs.gnu.org; Fri, 18 Nov 2022 08:47:05 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=MIME-version:Subject:From:To:Date:in-reply-to: references; bh=rC4Qo67TTtVMrbHX3HR+EJV8aqFo0pq7zumJ5WS2SMI=; b=rBAX8Lw7smhEk8 yBC0I5mL4+pyMdBC0BL/LpI0y6cRkMzpvM7mcOiBDNVzsNEqIsjjQBR+PWx+gt3Eg7kenvS8B0jOz sexx5RxFUVmS8rzzXI5mEcdBum4dXsmSjWeJiX8+0W9wQREI61ZdWPc/g/w5YbK5IU8Wz/yDeafqo gWnB/OXoCUHBaCRMfiz/miYgKFzNV5p7Cz9tydHfKPlyVSFruJ1jrwAYseiBK8S45fXxp0bIoa8x3 vO8SgHk4FsDzmObtb5eM2lFZ2q9Z66txT/OffdS1Yn+qScV/tnHlW/9Hzw7mXLUVqvWFUU+11m6HF azaKGDbUeqOQWCbB+khg==; Received: from [193.50.110.147] (helo=ribbon) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ow1hu-0004Qq-D6 for control@debbugs.gnu.org; Fri, 18 Nov 2022 08:47:04 -0500 Date: Fri, 18 Nov 2022 14:47:01 +0100 Message-Id: <875yfccr3e.fsf@gnu.org> To: control@debbugs.gnu.org From: =?utf-8?Q?Ludovic_Court=C3=A8s?= Subject: control message for bug #58648 MIME-version: 1.0 Content-type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: control X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) close 58648 quit From unknown Thu Jun 19 14:06:58 2025 Received: (at fakecontrol) by fakecontrolmessage; To: internal_control@debbugs.gnu.org From: Debbugs Internal Request Subject: Internal Control Message-Id: bug archived. Date: Sat, 17 Dec 2022 12:24:07 +0000 User-Agent: Fakemail v42.6.9 # This is a fake control message. # # The action: # bug archived. thanks # This fakemail brought to you by your local debbugs # administrator