Skip to content

Commit 329ac9a

Browse files
keesJonathan Corbet
authored andcommitted
docs: submitting-patches: Discuss interleaved replies
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. Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Kees Cook <keescook@chromium.org> Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230511184131.gonna.399-kees@kernel.org
1 parent d6534e3 commit 329ac9a

2 files changed

Lines changed: 29 additions & 3 deletions

File tree

Documentation/process/2.Process.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -434,9 +434,10 @@ There are a few hints which can help with linux-kernel survival:
434434
questions. Some developers can get impatient with people who clearly
435435
have not done their homework.
436436

437-
- Avoid top-posting (the practice of putting your answer above the quoted
438-
text you are responding to). It makes your response harder to read and
439-
makes a poor impression.
437+
- Use interleaved ("inline") replies, which makes your response easier to
438+
read. (i.e. avoid top-posting -- the practice of putting your answer above
439+
the quoted text you are responding to.) For more details, see
440+
:ref:`Documentation/process/submittingpatches.rst <interleaved_replies>`.
440441

441442
- Ask on the correct mailing list. Linux-kernel may be the general meeting
442443
point, but it is not the best place to find developers from all

Documentation/process/submitting-patches.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -331,6 +331,31 @@ explaining difference against previous submission (see
331331
See Documentation/process/email-clients.rst for recommendations on email
332332
clients and mailing list etiquette.
333333

334+
.. _interleaved_replies:
335+
336+
Use trimmed interleaved replies in email discussions
337+
----------------------------------------------------
338+
Top-posting is strongly discouraged in Linux kernel development
339+
discussions. Interleaved (or "inline") replies make conversations much
340+
easier to follow. For more details see:
341+
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
342+
343+
As is frequently quoted on the mailing list::
344+
345+
A: http://en.wikipedia.org/wiki/Top_post
346+
Q: Were do I find info about this thing called top-posting?
347+
A: Because it messes up the order in which people normally read text.
348+
Q: Why is top-posting such a bad thing?
349+
A: Top-posting.
350+
Q: What is the most annoying thing in e-mail?
351+
352+
Similarly, please trim all unneeded quotations that aren't relevant
353+
to your reply. This makes responses easier to find, and saves time and
354+
space. For more details see: http://daringfireball.net/2007/07/on_top ::
355+
356+
A: No.
357+
Q: Should I include quotations after my reply?
358+
334359
.. _resend_reminders:
335360

336361
Don't get discouraged - or impatient

0 commit comments

Comments
 (0)