qemu-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH 1/2] docs: Fix botched rST conversion of 'submitting-a-patch.


From: Thomas Huth
Subject: Re: [PATCH 1/2] docs: Fix botched rST conversion of 'submitting-a-patch.rst'
Date: Mon, 22 Nov 2021 13:36:53 +0100
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101 Thunderbird/91.3.0

On 22/11/2021 13.19, Kashyap Chamarthy wrote:
On Mon, Nov 22, 2021 at 11:36:54AM +0100, Thomas Huth wrote:
On 22/11/2021 11.20, Kashyap Chamarthy wrote:
On Mon, Nov 22, 2021 at 10:51:15AM +0100, Thomas Huth wrote:

[...]

I'll add the link to https://wiki.qemu.org/Contribute/SpellCheck again.

Please don't -- I intentionally dropped it in a previous iteration based
on this feedback from Peter Maydell:

      "I'm not sure that SpellCheck in particular is sufficiently baked
      to be in the actual docs. I'd rather just drop the reference to it
      from SubmitAPatch."
      (https://lists.nongnu.org/archive/html/qemu-devel/2021-11/msg00137.html)

Ok, so I'll drop that line completely (otherwise it does not really make
sense to have it in this list after the "See also:" right in front of it).

I kept that because an explicit reminder about spell-check is useful;
it's easy to forget.  Another option is to retain the line, but replace
"See also:" with "And:".  Not sure if it's any better.  But I don't mind
either way.

What about simply replacing it with a new sentence below the bullet list, saying:

"Please also use a spell checker like `codespell https://github.com/codespell-project/codespell` with your patches"

?

 Thomas




reply via email to

[Prev in Thread] Current Thread [Next in Thread]