From debbugs-submit-bounces@debbugs.gnu.org Tue Sep 21 05:59:20 2021 Received: (at 43946) by debbugs.gnu.org; 21 Sep 2021 09:59:20 +0000 Received: from localhost ([127.0.0.1]:44982 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mScYa-0003E8-6c for submit@debbugs.gnu.org; Tue, 21 Sep 2021 05:59:20 -0400 Received: from mail-wr1-f41.google.com ([209.85.221.41]:42591) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mScYX-0003Dl-H5 for 43946@debbugs.gnu.org; Tue, 21 Sep 2021 05:59:18 -0400 Received: by mail-wr1-f41.google.com with SMTP id q11so37377083wrr.9 for <43946@debbugs.gnu.org>; Tue, 21 Sep 2021 02:59:17 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:references:date:in-reply-to:message-id :user-agent:mime-version:content-transfer-encoding; bh=ztmCAsQ5pCXHCAzvXaElKWQZ+M5923uM3HmpWIJzI2c=; b=XfGJcumIknHk3IFrC/mNpc/PyCOc5WFDBFdDpCDXV5zehSLcQZ3hnCJHto6RcV/SXU z8hOe5N22Bav0cc0JZWwdtn3vujQoVgIX43nHnGJXn2ze5b5bVHMMO8jZyxXlubNzCb+ W8svquo4byP6j+bv0zqbYkdGZ2+MEOL3zd/k9kgwiUxio8eBkbtSssE11go7aMmR95c1 BchcVFXQ12qbvUQ2vGjTyL3ysla8Z437N17kUBKshAQlva9wAAjhXjujJpzb4yj+Q2Mo 62tZ34qEqfRzBHZ1qpYTuHuvq2b0qUKbfP0V/jH3qWyI/Q6B/fPiKRtlXQ5eHF+pA+Z2 RGSw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:references:date:in-reply-to :message-id:user-agent:mime-version:content-transfer-encoding; bh=ztmCAsQ5pCXHCAzvXaElKWQZ+M5923uM3HmpWIJzI2c=; b=6cSjZgg1Xq39QbCKOYGfsjxxLoAXsWB3xRbXMpujkqoNagxyQvd+bxMAXoljbO+gUx laU9QZ3+HpVFJ3XBulw41TZB/l0Oh1pSD66OjhqsePKNwmGbeeNShWg0KyE05S/+5Y4r uty4aTUeMFE0T15uCJWP44Pt+R6Ou+S+66d+iB9p9bSYU8nQ6VhNdnQwl8SS6R8lr+4q 44LdRRZml/NNbV+NdU/pmQOwgoZWXwOSv/Z5PX5DLz+LDLQN6vhJ9SUyqHCM82Q+hd6o xWtdk8FY6gvXjayQbfAXHXCMNPD8asgeBGkE6VJz7B2lH1DQT+K6FXhjl/mqIeGYkYyp sk8A== X-Gm-Message-State: AOAM53273iHcWWCCOkE7tOI/2V4iwtRS7Wd7FuocLoTrB8Qsyyjwv6Gm OH1XkoMtS08L5rxd50A22n5SP0hNsNY17A== X-Google-Smtp-Source: ABdhPJz9yAhQZNOAOFwUTJiVGOoF6cB2/DVcIUu6gEvd+7JNjYT6DAZe5ln6uLtagOhREi7RISC7PA== X-Received: by 2002:adf:f481:: with SMTP id l1mr2928322wro.411.1632218351506; Tue, 21 Sep 2021 02:59:11 -0700 (PDT) Received: from lili ([2a01:e0a:59b:9120:65d2:2476:f637:db1e]) by smtp.gmail.com with ESMTPSA id l21sm2286925wmh.31.2021.09.21.02.59.10 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 21 Sep 2021 02:59:11 -0700 (PDT) From: zimoun To: Ludovic =?utf-8?Q?Court=C3=A8s?= Subject: Re: [bug#43946] [PATCH] doc: Add item to "Submitting Patches" section. References: <20201012082003.19936-1-zimon.toutoune@gmail.com> <87zh1axr7c.fsf@gnu.org> Date: Tue, 21 Sep 2021 11:53:57 +0200 In-Reply-To: <87zh1axr7c.fsf@gnu.org> ("Ludovic =?utf-8?Q?Court=C3=A8s=22'?= =?utf-8?Q?s?= message of "Fri, 15 Jan 2021 14:30:47 +0100") Message-ID: <8635pyb6fe.fsf@gmail.com> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.1 (gnu/linux) 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: 43946 Cc: 43946@debbugs.gnu.org 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 Ludo, On Fri, 15 Jan 2021 at 14:30, Ludovic Court=C3=A8s wrote: > zimoun skribis: > >> * doc/contributing.texi (Submitting Patches): Add item about 'git-format= -patch >> --base'. >> --- >> doc/contributing.texi | 6 ++++++ >> 1 file changed, 6 insertions(+) >> >> diff --git a/doc/contributing.texi b/doc/contributing.texi >> index af3601442e..5ea3cb1899 100644 >> --- a/doc/contributing.texi >> +++ b/doc/contributing.texi >> @@ -932,6 +932,12 @@ Before submitting a patch that adds or modifies a p= ackage definition, >> please run through this check list: >>=20=20 >> @enumerate >> +@cindex @code{git format-patch} >> +@cindex @code{git-format-patch} >> +@item >> +We recommend to use the command @code{git format-patch --base} to >> +include the commit where your patch applies. > > I=E2=80=99m not entirely convinced TBH, in part because I know I often pi= le a > couple of WIP branches on top of one another, =E2=80=9Cknowing what I=E2= =80=99m doing=E2=80=9D > (actually hoping that I do), and so the base commit would be useless in > this case. Could you explain more? Here [#,@], I argument: --8<---------------cut here---------------start------------->8--- It is not because does not use this information that it cannot be a recommendation, i.e., a suggestion or advice on what seems helpful. Other said, it is not because it is "useless in this case" that it isuseless in other cases. For example, this information about which known commit that patch applies is helping for the automation of testing patches. Well, see [1,2] for instance. Discussions of such tooling happened in #44625 [3] and Emacs helper [4]. 1: https://git.kernel.org/pub/scm/utils/b4/b4.git/tree/README.rst 2: https://docs.kyleam.com/piem/Using-b4-to-apply-patches.html 3: http://issues.guix.gnu.org/44625 4: https://inbox.kyleam.com/piem/20201115061518.22191-1-kyle@kyleam.com/ [..] I still think that recommending to provide the commit on which it isknown that the patch (or patch set) applies is a good recommendation. Especially when the submission rate is greater than the review rate andthe tree is moving really quickly (yeah!). It is no extra work for the submitter and really helps for the reviewer. They applies at base-commit, checks, rebases and resolves conflicts if they are. Otherwise, the patch is useless or it needs to be rewritten by hand (or please indicate me how to do :-)). BTW, it helps automation tools. Sometimes, this base-commit is useless for the reviewer workflow but having it does not interfere. Having an information does not mean it must be used. However, not having an information implies it cannot be used. ;-) --8<---------------cut here---------------end--------------->8--- #: @: Seeing the number of patches in the patch tracker, most of them does not apply anymore. It is not encouraging to review and decrease the queue when first the reviewer has to guess onto which commit the patch applies. Cheers, simon