linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Drew DeVault <sir@cmpwn.com>
To: linux-doc@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>
Cc: Drew DeVault <sir@cmpwn.com>
Subject: [PATCH 2/4] Documentation/process: expand plain-text advice
Date: Wed,  2 Sep 2020 11:57:57 -0400	[thread overview]
Message-ID: <20200902155759.55895-3-sir@cmpwn.com> (raw)
In-Reply-To: <20200902155759.55895-1-sir@cmpwn.com>

This adds a link to https://useplaintext.email to email-clients.rst,
which is a more exhaustive resource on configuring various mail clients
for plain text use. submitting-patches.rst is also updated to direct
readers to email-clients.rst to equip new contributors with the
requisite knowledge to become a good participant on the mailing lists.

Signed-off-by: Drew DeVault <sir@cmpwn.com>
---
Conflict of interest: I wrote and maintain the website this links to.

 Documentation/process/email-clients.rst      | 5 +++++
 Documentation/process/submitting-patches.rst | 3 +++
 2 files changed, 8 insertions(+)

diff --git a/Documentation/process/email-clients.rst b/Documentation/process/email-clients.rst
index c9e4ce2613c0..16586f6cc888 100644
--- a/Documentation/process/email-clients.rst
+++ b/Documentation/process/email-clients.rst
@@ -25,6 +25,11 @@ attachments, but then the attachments should have content-type
 it makes quoting portions of the patch more difficult in the patch
 review process.
 
+It's also strongly recommended that you use plain text in your email body,
+for patches and other emails alike. https://useplaintext.email may be useful
+for information on how to configure your preferred email client, as well as
+listing recommended email clients should you not already have a preference.
+
 Email clients that are used for Linux kernel patches should send the
 patch text untouched.  For example, they should not modify or delete tabs
 or spaces, even at the beginning or end of lines.
diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
index f205753ae3d8..0dec104cb932 100644
--- a/Documentation/process/submitting-patches.rst
+++ b/Documentation/process/submitting-patches.rst
@@ -395,6 +395,9 @@ for their time.  Code review is a tiring and time-consuming process, and
 reviewers sometimes get grumpy.  Even in that case, though, respond
 politely and address the problems they have pointed out.
 
+See :ref:`Documentation/process/email-clients.rst` for recommendations on email
+clients and mailing list etiquette.
+
 
 Don't get discouraged - or impatient
 ---------------------------------------
-- 
2.28.0


  parent reply	other threads:[~2020-09-02 15:58 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-02 15:57 [PATCH 0/4] Improvements to submitting-patches.rst Drew DeVault
2020-09-02 15:57 ` [PATCH 1/4] submitting-patches.rst: remove heading numbering Drew DeVault
2020-09-03 15:44   ` Jonathan Corbet
2020-09-03 15:48     ` Drew DeVault
2020-09-03 15:46   ` Jonathan Corbet
2020-09-02 15:57 ` Drew DeVault [this message]
2020-09-02 16:06   ` [PATCH 2/4] Documentation/process: expand plain-text advice Randy Dunlap
2020-09-02 16:20     ` Drew DeVault
2020-09-03 15:47   ` Jonathan Corbet
2020-09-02 15:57 ` [PATCH 3/4] Documentation/maintainer: rehome sign-off process Drew DeVault
2020-09-03 15:50   ` Jonathan Corbet
2020-09-02 15:57 ` [PATCH 4/4] submitting-patches.rst: presume git will be used Drew DeVault
2020-09-02 16:11   ` Randy Dunlap
2020-09-02 16:11     ` Drew DeVault
2020-09-03 15:57   ` Jonathan Corbet

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200902155759.55895-3-sir@cmpwn.com \
    --to=sir@cmpwn.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).