Message ID | 20231115170330.16626-1-bp@alien8.de |
---|---|
State | New |
Headers |
Return-Path: <linux-kernel-owner@vger.kernel.org> Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:b909:0:b0:403:3b70:6f57 with SMTP id t9csp2676763vqg; Wed, 15 Nov 2023 09:04:03 -0800 (PST) X-Google-Smtp-Source: AGHT+IEV4kNyvxUZg96MqJp6OQjTfnA2DpfI54SwHR5CYef/q0pye7LiiN0/cgS5RrW8iw+tsETF X-Received: by 2002:a17:902:e543:b0:1cc:87f8:96bc with SMTP id n3-20020a170902e54300b001cc87f896bcmr7344446plf.15.1700067842881; Wed, 15 Nov 2023 09:04:02 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1700067842; cv=none; d=google.com; s=arc-20160816; b=oC6kmatS3q/vL3lxwO0Lai+pZ8CGWs04zCKQwNiXoqZEvN0yDWTuCKicRiTDineMAJ a9kFgB0GtfP5PqDZR2w2m8BCdy1I51D00SSiHNXPg8swqlDvxtn5BcIpkC9lje7E+Jrh AQ/PymO+EtVMNSZ8cUzWbL5V1eRwcjEyyg0dggt5Kkg4yCdlxxwd/90ewEau65zsCmPG bU6bzt4JESTREdf9H/bJvDpFY31UGuzcyy7t3wb29ZVnWr676S5R44wo8tcdHoltm0nj aRFQbEB8XFvrL8ObwOE87MSToiI4UmZFsXhLfx+pdOwHhmLdr3yvG+mXFdmbg2i/Hh5c Hl+Q== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:from:dkim-signature; bh=vClyWK0syigKFA2h7f6qP0p78cB+5d+cnAB7Gzf3cfA=; fh=Oh73biWCZdWKTyksY5BEelhSSGAaOGqqIoyl3jKXFmo=; b=JgWdPXyKEm4BprMmRyXhJowl5q8iNJLjClZ9hj51GeckKWNwk9FuUwUFSRhzeHtraG X4SCXtbcBsAVUkWI+Gosr0w/r2R9y1rV3mv9aKqsODORetkvoX6AxPtgjVuqUZ4S/OfQ k2mB2+UM2FqRnp1IbGLabY7C/dB6sp8xvWsaYIm601ARHMsTpAV6tjBFntuXw1+DscXm GOSh7D7Y8X365LkUhDPlUv0iIz5BIhGFgeiNsQ89DmmND04xXNDH7EPhe+biyx3ROXqK SsS2jt54pKbHIRGPAZaYXw9ocwzHLlQoe19ZFqAMheOkWgjn1pqLyw58M7q5g1N98bmD bkkQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@alien8.de header.s=alien8 header.b=O27Cjsls; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:8 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=alien8.de Received: from fry.vger.email (fry.vger.email. [2620:137:e000::3:8]) by mx.google.com with ESMTPS id b6-20020a170902d50600b001c9b20887afsi10812685plg.431.2023.11.15.09.04.01 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 15 Nov 2023 09:04:02 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:8 as permitted sender) client-ip=2620:137:e000::3:8; Authentication-Results: mx.google.com; dkim=neutral (body hash did not verify) header.i=@alien8.de header.s=alien8 header.b=O27Cjsls; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:8 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=alien8.de Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0]) by fry.vger.email (Postfix) with ESMTP id 33DAB81113B7; Wed, 15 Nov 2023 09:03:59 -0800 (PST) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.11 at fry.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232153AbjKORDv (ORCPT <rfc822;lhua1029@gmail.com> + 29 others); Wed, 15 Nov 2023 12:03:51 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:46654 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230106AbjKORDt (ORCPT <rfc822;linux-kernel@vger.kernel.org>); Wed, 15 Nov 2023 12:03:49 -0500 Received: from mail.alien8.de (mail.alien8.de [65.109.113.108]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 7BEACFA; Wed, 15 Nov 2023 09:03:46 -0800 (PST) Received: from localhost (localhost.localdomain [127.0.0.1]) by mail.alien8.de (SuperMail on ZX Spectrum 128k) with ESMTP id CA28E40E0032; Wed, 15 Nov 2023 17:03:44 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at mail.alien8.de Authentication-Results: mail.alien8.de (amavisd-new); dkim=fail (4096-bit key) reason="fail (body has been altered)" header.d=alien8.de Received: from mail.alien8.de ([127.0.0.1]) by localhost (mail.alien8.de [127.0.0.1]) (amavisd-new, port 10026) with ESMTP id asOoiNB63C-s; Wed, 15 Nov 2023 17:03:43 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=alien8.de; s=alien8; t=1700067821; bh=an9uHtOOfwZ20jFxIxiszaxxIhJNMZCCPcUQiGwprz8=; h=From:To:Cc:Subject:Date:From; b=O27Cjsls5UQYxS58yXvaIogJO1qGohBD7U53TNW2ha7d6VCXu7YEavDZ6byiW71tp 9nqA9Lt81DEaOi9lFKev3P35k2iwSnQFCdoEUORVJFARdYd1LXegMTgHUbfk50Ps6V OVXOTJkSl62IiwAwzmOUFwHCpVNACs+I0Sg4fEtZv88nr8DAZsLWayu+R53Se3m0ii aP4/Yh7RmKp73FHLLhuE+4SRFlCj3K1Cy/g07qW6e4kAw2Oq5m0tNPo5NoLvSgr+Ei saqM6Dnf9kVcftWYm9JRBumRLIRF6YYvkAhMlz1nKfxrIXCLYsD1d+3Iw1n/mJJn34 QO/662xQaoRQN9K4yEBu3o/F0mwNZtSHJ6aQkBYyvHW17InIOaUBAZCXD8DFIWl7pt XAHyN9AjcS9Amlu5uUzqw0KRWXvpHTXJ1ZovnpQoF2Kspb1/aLkMwa7J/ZwnMGUK34 IciQQZiv3lEj6uMOb1YS7YD9Bx5WwgfzfBd8yjbtJvP0nZUuWohPLQNi0oVZ3DkyWw 41ySvi07Bi+9XIi3uADbs1BqErHZNmmrSyFMr5yh/GvqChupZNhsUMvPVnAijr3IZy DY/erESd5iOrOl3EzesbzVzRcZtTy42r3RnqmwH7QYUUhmtJsLhTCQ0UtPnt1yNKDt 9JBAoNgEwvyAOYybSFB7RSsc= Received: from zn.tnic (pd95304da.dip0.t-ipconnect.de [217.83.4.218]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange ECDHE (P-256) server-signature ECDSA (P-256) server-digest SHA256) (No client certificate requested) by mail.alien8.de (SuperMail on ZX Spectrum 128k) with ESMTPSA id 2BADE40E0030; Wed, 15 Nov 2023 17:03:37 +0000 (UTC) From: Borislav Petkov <bp@alien8.de> To: Jonathan Corbet <corbet@lwn.net> Cc: workflows@vger.kernel.org, linux-doc@vger.kernel.org, LKML <linux-kernel@vger.kernel.org> Subject: [PATCH] docs: submitting-patches: improve the base commit explanation Date: Wed, 15 Nov 2023 18:03:30 +0100 Message-ID: <20231115170330.16626-1-bp@alien8.de> X-Mailer: git-send-email 2.42.0.rc0.25.ga82fb66fed25 MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Spam-Status: No, score=-0.6 required=5.0 tests=DKIM_INVALID,DKIM_SIGNED, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,SPF_HELO_NONE, SPF_PASS,T_SCC_BODY_TEXT_LINE autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on fry.vger.email Precedence: bulk List-ID: <linux-kernel.vger.kernel.org> X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (fry.vger.email [0.0.0.0]); Wed, 15 Nov 2023 09:03:59 -0800 (PST) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1782650338538509624 X-GMAIL-MSGID: 1782650338538509624 |
Series |
docs: submitting-patches: improve the base commit explanation
|
|
Commit Message
Borislav Petkov
Nov. 15, 2023, 5:03 p.m. UTC
From: "Borislav Petkov (AMD)" <bp@alien8.de> After receiving a second patchset this week without knowing which tree it applies on and trying to apply it on the obvious ones and failing, make sure the base tree information which needs to be supplied in the 0th message of the patchset is spelled out more explicitly. Also, make the formulations stronger as this really is a requirement and not only a useful thing anymore. Signed-off-by: Borislav Petkov (AMD) <bp@alien8.de> --- Documentation/process/submitting-patches.rst | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-)
Comments
On Wed, Nov 15, 2023 at 06:03:30PM +0100, Borislav Petkov wrote: > From: "Borislav Petkov (AMD)" <bp@alien8.de> > > After receiving a second patchset this week without knowing which tree > it applies on and trying to apply it on the obvious ones and failing, > make sure the base tree information which needs to be supplied in the > 0th message of the patchset is spelled out more explicitly. > > Also, make the formulations stronger as this really is a requirement and > not only a useful thing anymore. > > Signed-off-by: Borislav Petkov (AMD) <bp@alien8.de> Yup, I wonder if making "--base=auto" a default in git might be a good idea too? Reviewed-by: Kees Cook <keescook@chromium.org>
On Wed, Nov 15, 2023 at 09:49:31AM -0800, Kees Cook wrote: > On Wed, Nov 15, 2023 at 06:03:30PM +0100, Borislav Petkov wrote: > > From: "Borislav Petkov (AMD)" <bp@alien8.de> > > > > After receiving a second patchset this week without knowing which tree > > it applies on and trying to apply it on the obvious ones and failing, > > make sure the base tree information which needs to be supplied in the > > 0th message of the patchset is spelled out more explicitly. > > > > Also, make the formulations stronger as this really is a requirement and > > not only a useful thing anymore. > > > > Signed-off-by: Borislav Petkov (AMD) <bp@alien8.de> > > Yup, I wonder if making "--base=auto" a default in git might be a good > idea too? When the base of a series is in Linus' tree, or in the corresponding subsystem maintainer's tree, things are easy, but there are many situations where the base is a merge of multiple branches (perhaps a for-next and a fixes branch for instance), or where prerequisites have been applied manually for one reason or another. This can and should of course be described in the cover letter, and the submitter should push and provide a link to a branch that contains the series on top of the appropriate base (or just a link to the base). This won't help the bots much though, if they just look at the base tag. Is there a way, or can we standardize on a way, to indicate where the base can be found ? > Reviewed-by: Kees Cook <keescook@chromium.org>
On Wed, Nov 15, 2023 at 09:49:31AM -0800, Kees Cook wrote: > On Wed, Nov 15, 2023 at 06:03:30PM +0100, Borislav Petkov wrote: > > From: "Borislav Petkov (AMD)" <bp@alien8.de> > > > > After receiving a second patchset this week without knowing which tree > > it applies on and trying to apply it on the obvious ones and failing, > > make sure the base tree information which needs to be supplied in the > > 0th message of the patchset is spelled out more explicitly. > > > > Also, make the formulations stronger as this really is a requirement and > > not only a useful thing anymore. > > > > Signed-off-by: Borislav Petkov (AMD) <bp@alien8.de> > > Yup, I wonder if making "--base=auto" a default in git might be a good > idea too? Not a bad idea. And if not needed, one can simply ignore it when reading the cover letter. CCing the git ML for comment/opinions. Thx.
On Wed, Nov 15, 2023 at 07:56:32PM +0200, Laurent Pinchart wrote: > When the base of a series is in Linus' tree, or in the corresponding > subsystem maintainer's tree, things are easy, but there are many > situations where the base is a merge of multiple branches (perhaps a > for-next and a fixes branch for instance), or where prerequisites have > been applied manually for one reason or another. This can and should of > course be described in the cover letter, and the submitter should push > and provide a link to a branch that contains the series on top of the > appropriate base (or just a link to the base). This won't help the bots > much though, if they just look at the base tag. Is there a way, or can > we standardize on a way, to indicate where the base can be found ? Yes, I suggest we use: base-repository: <some-canonical-repo-url> So, a b4-submitted series will have these footers: change-id: <unique-series-id> base-commit: <commit-id-or-tag> base-repository: <canonical-repo-url> (And then, eventually, there will be series dependency info in the format: requires: <unique-series-id>:<version> -K
Borislav Petkov <bp@alien8.de> writes: > From: "Borislav Petkov (AMD)" <bp@alien8.de> > > After receiving a second patchset this week without knowing which tree > it applies on and trying to apply it on the obvious ones and failing, > make sure the base tree information which needs to be supplied in the > 0th message of the patchset is spelled out more explicitly. > > Also, make the formulations stronger as this really is a requirement and > not only a useful thing anymore. > > Signed-off-by: Borislav Petkov (AMD) <bp@alien8.de> > --- > Documentation/process/submitting-patches.rst | 15 +++++++++++---- > 1 file changed, 11 insertions(+), 4 deletions(-) Applied, thanks. jon
diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst index 86d346bcb8ef..66029999b587 100644 --- a/Documentation/process/submitting-patches.rst +++ b/Documentation/process/submitting-patches.rst @@ -790,10 +790,14 @@ Providing base tree information ------------------------------- When other developers receive your patches and start the review process, -it is often useful for them to know where in the tree history they -should place your work. This is particularly useful for automated CI -processes that attempt to run a series of tests in order to establish -the quality of your submission before the maintainer starts the review. +it is absolutely necessary for them to know what is the base +commit/branch your work applies on, considering the sheer amount of +maintainer trees present nowadays. Note again the **T:** entry in the +MAINTAINERS file explained above. + +This is even more important for automated CI processes that attempt to +run a series of tests in order to establish the quality of your +submission before the maintainer starts the review. If you are using ``git format-patch`` to generate your patches, you can automatically include the base tree information in your submission by @@ -836,6 +840,9 @@ letter or in the first patch of the series and it should be placed either below the ``---`` line or at the very bottom of all other content, right before your email signature. +Make sure that base commit is in an official maintainer/mainline tree +and not in some internal, accessible only to you tree - otherwise it +would be worthless. References ----------