Thread (5 messages) 5 messages, 3 authors, 2023-05-13

Re: [PATCH] docs: submitting-patches: Discuss interleaved replies

From: Kees Cook <hidden>
Date: 2023-05-11 18:38:44
Also in: linux-hardening, lkml

On Thu, May 11, 2023 at 11:21:36AM +0200, Thorsten Leemhuis wrote:
On 10.05.23 20:34, Kees Cook wrote:
quoted
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.
quoted
[...]
---
 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. :)
quoted
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.
quoted
+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.
quoted
+space. For more details see: http://daringfireball.net/2007/07/on_top
[...]
Ciao, Thorsten
Thanks!

-- 
Kees Cook
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help