Re: [PATCH 2/4] Documentation/process: expand plain-text advice

[Randy Dunlap <rdunlap@infradead.org>]

On 9/2/20 8:57 AM, Drew DeVault wrote:
> 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

You could justify that first sentence by adding that some mailing lists drop/discard
emails that are in html.

> +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
>  ---------------------------------------
> 

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

-- 
~Randy