Message ID | 20230510183423.never.877-kees@kernel.org |
---|---|
State | New |
Headers |
Return-Path: <linux-kernel-owner@vger.kernel.org> Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:b0ea:0:b0:3b6:4342:cba0 with SMTP id b10csp3843852vqo; Wed, 10 May 2023 11:47:07 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ77Jknaselh/jGNKeTOtXTIP168z2EHpGCREo3hQUT+EGZUa1VruF/JQ+ZG/0XJuMXYsIgU X-Received: by 2002:a05:6a00:1305:b0:63d:641f:5048 with SMTP id j5-20020a056a00130500b0063d641f5048mr22242573pfu.16.1683744426964; Wed, 10 May 2023 11:47:06 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1683744426; cv=none; d=google.com; s=arc-20160816; b=cteaQEt/67GhgR/LrlIl9GqGKGtXP9ATStP/cyyJMjAnyKbd81I0UBUEUHsWhxK0YS 8qqM7yQSaq2M2uWpUlsKpWoEoUzVm1mFQNWpolNcRkc7/44vbGw0gS4QZIGBC/HgatQr Fx7sHpSLU2Dz6F/PzJMnoRE9HlDJZTwLXwJz8XVbaJi6ObZBiYTDKoSbp73DEigaF2rP XPbWAEM2yo07BKORNc7Du15ixBSdd5daTe6GsKTQo5AjdyzA2NaVou9h8AuN/PIEdaVk 3poI0hxfmbi0NZHvQmk94atJiAQIKBPnf/RWkyI/oq1XDoIQ6maEC/kP7nwpXoUDtrRd 8pyw== 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=JRjSTeKVaSeHOGoAF38z8GpTE5mDcr1s8fb1MR5ncQQ=; b=ljh1I7BXzfqDtyRaLc0w4SkULNdX0WcFrHfG7sXCgu30YQH43gHOGMYzbq5L7u649u UvqVefEYQfe2IJfj6ylNjOSyehfKu14r9bBtxUvOjTTtI/W+WNmV1qJHq/KNui8AYa6V rEo5CYMcMYDPnWBLABjVyZ5FzC73fJkP/NW49+BDBcp02KYmd/Rj5OaxhSZGAC0Pt+Jl dWMTYW53TQt6mZhOz3V7kLWhwKEEubeEHpollPwuqTV6QT4n5KeIkF8vubzE2nzVELQO lYQF2xh/ZXRt1J2h0UhPmeWQn45mLGeQt92c+vBeyXZs/w6bKJ+R5FvKGp64S79SyDPB xifA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@chromium.org header.s=google header.b=J48bmcMY; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=chromium.org Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id i15-20020a633c4f000000b005303bde6431si4811966pgn.895.2023.05.10.11.46.53; Wed, 10 May 2023 11:47:06 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@chromium.org header.s=google header.b=J48bmcMY; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=chromium.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234959AbjEJSeh (ORCPT <rfc822;jeantsuru.cumc.mandola@gmail.com> + 99 others); Wed, 10 May 2023 14:34:37 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:37974 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229461AbjEJSef (ORCPT <rfc822;linux-kernel@vger.kernel.org>); Wed, 10 May 2023 14:34:35 -0400 Received: from mail-pl1-x632.google.com (mail-pl1-x632.google.com [IPv6:2607:f8b0:4864:20::632]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 978244214 for <linux-kernel@vger.kernel.org>; Wed, 10 May 2023 11:34:29 -0700 (PDT) Received: by mail-pl1-x632.google.com with SMTP id d9443c01a7336-1aaec6f189cso52977415ad.3 for <linux-kernel@vger.kernel.org>; Wed, 10 May 2023 11:34:29 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1683743669; x=1686335669; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=JRjSTeKVaSeHOGoAF38z8GpTE5mDcr1s8fb1MR5ncQQ=; b=J48bmcMYPTBxc7NY29p9Y/M3yvVSOjj2esN3F5CQ44Yhbr7aD/wdU5tVIrkzyL6kws t1FU0K7ijV6wKfFk5YoEM0C/YuCRxUV8/DFoL3gWdKx2hDMdAURAY8MH3D4fU3ntuAJt +xeeefYWhE0CKhn02lMrr9BeYKI0h2ck4xszw= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1683743669; x=1686335669; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=JRjSTeKVaSeHOGoAF38z8GpTE5mDcr1s8fb1MR5ncQQ=; b=j9XwUVHCj9Bt8glOQH5D+e8sG0US67Yrp1r2EKiUwj5m2Vig8ja5+/ibC0MwKHHo2Y ppRwm7KaDb5Ykd5oovty2XANXT/ElcmVdicruNu4N4dSN4BHeDKUda8sKMfZwD+nkX7n wMbt6l+He+h0l3fUJCtvDgz7tptJhv2ot4Ilh2Qt52SkBgKsV/5FgACwTrsf8786Si1h 1AsWbenOUIDbRcwRODAieK4SsDznKERpBHd/3KcYe/hbr5OXDAq2J/QTtiFRMcTXHcpR 7ZidezsaoIRb3zUtcg6aEAAo5+wgi8ekmgch2q3wwBJ/zQ6OUFwoXCsN5fy6ttRKU0P8 39ow== X-Gm-Message-State: AC+VfDydtMXudkv4qIgsl6OS95qjBNMZF5YFvYTggkl2DRm4fZwG1/m+ 7wqlOFmxbjkq6HebnEQ2aJQARQ== X-Received: by 2002:a17:903:41ca:b0:1ac:3fe0:d6ad with SMTP id u10-20020a17090341ca00b001ac3fe0d6admr21337510ple.65.1683743668783; Wed, 10 May 2023 11:34:28 -0700 (PDT) Received: from www.outflux.net (198-0-35-241-static.hfc.comcastbusiness.net. [198.0.35.241]) by smtp.gmail.com with ESMTPSA id h11-20020a170902b94b00b00194d14d8e54sm4116575pls.96.2023.05.10.11.34.28 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 10 May 2023 11:34:28 -0700 (PDT) From: Kees Cook <keescook@chromium.org> To: Jonathan Corbet <corbet@lwn.net> Cc: Kees Cook <keescook@chromium.org>, Greg Kroah-Hartman <gregkh@linuxfoundation.org>, Thorsten Leemhuis <linux@leemhuis.info>, Rong Tao <rtoax@foxmail.com>, Lukas Bulwahn <lukas.bulwahn@gmail.com>, Zhangfei Gao <zhangfei.gao@foxmail.com>, linux-doc@vger.kernel.org, linux-hardening@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH] docs: submitting-patches: Discuss interleaved replies Date: Wed, 10 May 2023 11:34:26 -0700 Message-Id: <20230510183423.never.877-kees@kernel.org> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=2245; h=from:subject:message-id; bh=62J3Py/xWz6AlwkgtpxlRn/9sYY0pprOtTpQVwzh/Q8=; b=owEBbQKS/ZANAwAKAYly9N/cbcAmAcsmYgBkW+OysP6gOL4ASHG7jWh1uOMcr8jtnn94Osy5E0HQ fc8kCQ2JAjMEAAEKAB0WIQSlw/aPIp3WD3I+bhOJcvTf3G3AJgUCZFvjsgAKCRCJcvTf3G3AJvQsD/ 9z8s9JuH+k6UL4au4I11PpdN5X1n/sgyE4XsY/Wd8C00wOZ+BIY1WVIbGDgquguLIOtBCX6Mk5oqwW 1sYQWrB9Eol+pazYXf7fvdIOsHTcQqBsXVI+TVAA1KVoi10YmxATRKIPr6Iy7dRLMHsbmbMmPQP34s 9iTw5Keao/nF8Ug4XBZJJD63p1zizFKA85py+RXnXe6D1c5FPpIvxlt7ipRyWqCuunxPHG2vNUdLU2 Y1Js5UhznDgh9RznZIYxmTc6I9eNymyZtlBQ7qqxOsHw4aOFUwInXDh6//OSpcfVeFR0Np2d1f/Dcf ckX6bVfUzui4JdgynpKoG6OFr5HqdHGe72hy6MKUpdSkoPhxaumlSFHiLdHrmeTS5KlSSQWl2rwmnM bde06LFSGPW5M7KDCkab6jIfMra9kqgKEKsn9Hy+YqxLm+PEJ/dDtmHEQIFq7I1km+6K2rgqyJgVt/ uXe/H2dECvorifZDR3v3bn35G3FUGDSGPDqkIOdFf6h1D3InMpHtUcfqz28hM8pVQ8ZB7dvirqD0W4 yXDNNzetxNqtGS//uNp4FlA1vo3Er7PtlwORxTy50sVi/tc21iKC0/jbVtuXADBUdgAZseYAZqyPwL GJEtRBennd45PSR5J2ytgom3IKqxRT8AXjPYm/XpFrDzKxQFB27BoGurPcXg== X-Developer-Key: i=keescook@chromium.org; a=openpgp; fpr=A5C3F68F229DD60F723E6E138972F4DFDC6DC026 Content-Transfer-Encoding: 8bit X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_NONE, SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: <linux-kernel.vger.kernel.org> X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1765533995911279128?= X-GMAIL-MSGID: =?utf-8?q?1765533995911279128?= |
Series |
docs: submitting-patches: Discuss interleaved replies
|
|
Commit Message
Kees Cook
May 10, 2023, 6:34 p.m. UTC
Top-posting has been strongly discouraged in Linux development, but this
was actually not written anywhere in the common documentation about
sending patches and replying to reviews. Add a section about trimming
and interleaved replies.
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Thorsten Leemhuis <linux@leemhuis.info>
Cc: Rong Tao <rtoax@foxmail.com>
Cc: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Cc: Zhangfei Gao <zhangfei.gao@foxmail.com>
Cc: linux-doc@vger.kernel.org
Cc: linux-hardening@vger.kernel.org
Signed-off-by: Kees Cook <keescook@chromium.org>
---
Documentation/process/submitting-patches.rst | 23 ++++++++++++++++++++
1 file changed, 23 insertions(+)
Comments
On Wed, May 10, 2023 at 11:34:26AM -0700, Kees Cook wrote: > Top-posting has been strongly discouraged in Linux development, but this > was actually not written anywhere in the common documentation about > sending patches and replying to reviews. Add a section about trimming > and interleaved replies. > > Cc: Jonathan Corbet <corbet@lwn.net> > Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org> > Cc: Thorsten Leemhuis <linux@leemhuis.info> > Cc: Rong Tao <rtoax@foxmail.com> > Cc: Lukas Bulwahn <lukas.bulwahn@gmail.com> > Cc: Zhangfei Gao <zhangfei.gao@foxmail.com> > Cc: linux-doc@vger.kernel.org > Cc: linux-hardening@vger.kernel.org > Signed-off-by: Kees Cook <keescook@chromium.org> > --- > Documentation/process/submitting-patches.rst | 23 ++++++++++++++++++++ > 1 file changed, 23 insertions(+) > > diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst > index eac7167dce83..3e838da8822f 100644 > --- a/Documentation/process/submitting-patches.rst > +++ b/Documentation/process/submitting-patches.rst > @@ -326,6 +326,29 @@ explaining difference aganst previous submission (see > See Documentation/process/email-clients.rst for recommendations on email > clients and mailing list etiquette. > > +Use trimmed interleaved replies in email discussions > +---------------------------------------------------- > +Top-posting is strongly discouraged in Linux kernel development > +discusions. Interleaved (or "inline") replies make conversations much > +easier to follow. For more details see: > +https://en.wikipedia.org/wiki/Posting_style#Interleaved_style > + > +As is frequently quoted on the mailing list: > + > + A: http://en.wikipedia.org/wiki/Top_post > + Q: Were do I find info about this thing called top-posting? > + A: Because it messes up the order in which people normally read text. > + Q: Why is top-posting such a bad thing? > + A: Top-posting. > + Q: What is the most annoying thing in e-mail? > + > +Similarly, please trim all unneeded quotations that aren't relevant > +to your reply. This makes replies easier to find, and saves time and > +space. For more details see: http://daringfireball.net/2007/07/on_top > + > + A: No. > + Q: Should I include quotations after my reply? > + > .. _resend_reminders: > > Don't get discouraged - or impatient > -- > 2.34.1 > Yes!!! Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
On 10.05.23 20:34, Kees Cook wrote: > Top-posting has been strongly discouraged in Linux development, but this > was actually not written anywhere in the common documentation about > sending patches and replying to reviews. Add a section about trimming > and interleaved replies. Thx for doing this. > [...] > --- > Documentation/process/submitting-patches.rst | 23 ++++++++++++++++++++ > 1 file changed, 23 insertions(+) For some reason we have duplicate code^w documentation for this, hence I'd say the same or a similar text should also be added to one of the filed in Documentation/process/[0-9].*rst ; from a quick Documentation/process/6.Followthrough.rst might be the best one. Maybe in fact the text should move there and submitting-patches.rst should have a much shorter version, as it's meant to be the terser of the two docs about this. > diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst > index eac7167dce83..3e838da8822f 100644 > --- a/Documentation/process/submitting-patches.rst > +++ b/Documentation/process/submitting-patches.rst > @@ -326,6 +326,29 @@ explaining difference aganst previous submission (see > See Documentation/process/email-clients.rst for recommendations on email > clients and mailing list etiquette. > > +Use trimmed interleaved replies in email discussions > +---------------------------------------------------- > +Top-posting is strongly discouraged in Linux kernel development > +discusions. Interleaved (or "inline") replies make conversations much s/discusions/discussions/ > +easier to follow. For more details see: > +https://en.wikipedia.org/wiki/Posting_style#Interleaved_style > + > +As is frequently quoted on the mailing list: > + > + A: http://en.wikipedia.org/wiki/Top_post > + Q: Were do I find info about this thing called top-posting? > + A: Because it messes up the order in which people normally read text. > + Q: Why is top-posting such a bad thing? > + A: Top-posting. > + Q: What is the most annoying thing in e-mail? > + > +Similarly, please trim all unneeded quotations that aren't relevant > +to your reply. This makes replies easier to find, and saves time and Nitpicking, feel free to ignore: maybe "s/replies/responses/" or something like that, as at least my stupid brain accidentally thought of the email reply (as whole) when reading this for the first time. > +space. For more details see: http://daringfireball.net/2007/07/on_top > [...] Ciao, Thorsten
On Thu, May 11, 2023 at 11:21:36AM +0200, Thorsten Leemhuis wrote: > On 10.05.23 20:34, Kees Cook wrote: > > Top-posting has been strongly discouraged in Linux development, but this > > was actually not written anywhere in the common documentation about > > sending patches and replying to reviews. Add a section about trimming > > and interleaved replies. > > Thx for doing this. > > > [...] > > --- > > Documentation/process/submitting-patches.rst | 23 ++++++++++++++++++++ > > 1 file changed, 23 insertions(+) > > For some reason we have duplicate code^w documentation for this, hence > I'd say the same or a similar text should also be added to one of the > filed in Documentation/process/[0-9].*rst ; from a quick > Documentation/process/6.Followthrough.rst might be the best one. > > Maybe in fact the text should move there and submitting-patches.rst > should have a much shorter version, as it's meant to be the terser of > the two docs about this. Hm, The place where it is mentioned is even shorter, so I kind of like it in submittingpatches. But, I'm open to whatever seems best. I just want to have a URL to point people at, and I'm usually pointing to places in submittingpatches. :) > > > diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst > > index eac7167dce83..3e838da8822f 100644 > > --- a/Documentation/process/submitting-patches.rst > > +++ b/Documentation/process/submitting-patches.rst > > @@ -326,6 +326,29 @@ explaining difference aganst previous submission (see > > See Documentation/process/email-clients.rst for recommendations on email > > clients and mailing list etiquette. > > > > +Use trimmed interleaved replies in email discussions > > +---------------------------------------------------- > > +Top-posting is strongly discouraged in Linux kernel development > > +discusions. Interleaved (or "inline") replies make conversations much > > s/discusions/discussions/ Agh, thanks. Fixed. > > > +easier to follow. For more details see: > > +https://en.wikipedia.org/wiki/Posting_style#Interleaved_style > > + > > +As is frequently quoted on the mailing list: > > + > > + A: http://en.wikipedia.org/wiki/Top_post > > + Q: Were do I find info about this thing called top-posting? > > + A: Because it messes up the order in which people normally read text. > > + Q: Why is top-posting such a bad thing? > > + A: Top-posting. > > + Q: What is the most annoying thing in e-mail? > > + > > +Similarly, please trim all unneeded quotations that aren't relevant > > +to your reply. This makes replies easier to find, and saves time and > > Nitpicking, feel free to ignore: maybe "s/replies/responses/" or > something like that, as at least my stupid brain accidentally thought of > the email reply (as whole) when reading this for the first time. Yeah, that is more readable. Fixed. > > +space. For more details see: http://daringfireball.net/2007/07/on_top > > [...] > > Ciao, Thorsten Thanks!
On 11.05.23 20:37, Kees Cook wrote: > On Thu, May 11, 2023 at 11:21:36AM +0200, Thorsten Leemhuis wrote: >> On 10.05.23 20:34, Kees Cook wrote: >>> Top-posting has been strongly discouraged in Linux development, but this >>> was actually not written anywhere in the common documentation about >>> sending patches and replying to reviews. Add a section about trimming >>> and interleaved replies. >> >> Thx for doing this. >> >>> [...] >>> --- >>> Documentation/process/submitting-patches.rst | 23 ++++++++++++++++++++ >>> 1 file changed, 23 insertions(+) >> >> For some reason we have duplicate code^w documentation for this, hence >> I'd say the same or a similar text should also be added to one of the >> filed in Documentation/process/[0-9].*rst ; from a quick >> Documentation/process/6.Followthrough.rst might be the best one. >> >> Maybe in fact the text should move there and submitting-patches.rst >> should have a much shorter version, as it's meant to be the terser of >> the two docs about this. > > Hm, The place where it is mentioned is even shorter, Ohh, it is mentioned there already? I briefly looked, but had missed it. Sorry. :-/ > so I kind of like > it in submittingpatches. But, I'm open to whatever seems best. Guess that is Jonathan's call to make. Your v2 patch to me looks a bit like adding quite a bit of new and slow code to the fast path while adjusting faster code in the slow path. But the relation and interaction between those two texts in a bit messy already, so maybe it doesn't matter that much. Ciao, Thorsten
diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst index eac7167dce83..3e838da8822f 100644 --- a/Documentation/process/submitting-patches.rst +++ b/Documentation/process/submitting-patches.rst @@ -326,6 +326,29 @@ explaining difference aganst previous submission (see See Documentation/process/email-clients.rst for recommendations on email clients and mailing list etiquette. +Use trimmed interleaved replies in email discussions +---------------------------------------------------- +Top-posting is strongly discouraged in Linux kernel development +discusions. Interleaved (or "inline") replies make conversations much +easier to follow. For more details see: +https://en.wikipedia.org/wiki/Posting_style#Interleaved_style + +As is frequently quoted on the mailing list: + + A: http://en.wikipedia.org/wiki/Top_post + Q: Were do I find info about this thing called top-posting? + A: Because it messes up the order in which people normally read text. + Q: Why is top-posting such a bad thing? + A: Top-posting. + Q: What is the most annoying thing in e-mail? + +Similarly, please trim all unneeded quotations that aren't relevant +to your reply. This makes replies easier to find, and saves time and +space. For more details see: http://daringfireball.net/2007/07/on_top + + A: No. + Q: Should I include quotations after my reply? + .. _resend_reminders: Don't get discouraged - or impatient