All of lore.kernel.org
 help / color / mirror / Atom feed
From: Kashyap Chamarthy <kchamart@redhat.com>
To: qemu-devel@nongnu.org
Cc: Peter Maydell <peter.maydell@linaro.org>,
	Thomas Huth <thuth@redhat.com>,
	Kashyap Chamarthy <kchamart@redhat.com>,
	John Snow <jsnow@redhat.com>, Michael Tokarev <mjt@tls.msk.ru>,
	Laurent Vivier <laurent@vivier.eu>,
	Stefan Hajnoczi <stefanha@redhat.com>,
	Paolo Bonzini <pbonzini@redhat.com>,
	Eric Blake <eblake@redhat.com>
Subject: [PATCH 1/3] docs: rSTify the "SpellCheck" wiki
Date: Wed, 22 Sep 2021 14:10:52 +0200	[thread overview]
Message-ID: <20210922121054.1458051-2-kchamart@redhat.com> (raw)
In-Reply-To: <20210922121054.1458051-1-kchamart@redhat.com>

The original wiki is here[1].  I converted by copying the wiki source[2]
into a .wiki file and convert to rST using `pandoc`:

    $ pandoc -f Mediawiki -t rst spell-check.wiki -o spell-check.rst

[1] https://wiki.qemu.org/Contribute/SpellCheck
[2] https://web.archive.org/web/20170721031029/http://wiki.qemu.org/index.php?title=Contribute/SubmitAPatch&action=edit

Signed-off-by: Kashyap Chamarthy <kchamart@redhat.com>
---
 docs/devel/spell-check.rst | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 docs/devel/spell-check.rst

diff --git a/docs/devel/spell-check.rst b/docs/devel/spell-check.rst
new file mode 100644
index 0000000000..998cd7ef51
--- /dev/null
+++ b/docs/devel/spell-check.rst
@@ -0,0 +1,29 @@
+===========
+Spell Check
+===========
+
+QEMU uses British or American English in code and documentation. There
+are some typical spelling bugs which can be easily avoided by using
+tools like codespell.
+
+codespell is a python script which detects (and optionally fixes) the
+most common spelling bugs.
+
+If you installed codespell in your HOME directory, it can be called from
+the QEMU source directory like this::
+
+    ~/bin/codespell.py -d -r -s -x scripts/codespell.exclude -q 2 ~/share/codespell/dictionary.txt
+
+``-x scripts/codespell.exclude`` excludes some known lines from the check
+and needs a file which is not yet committed.
+
+.. _external_links:
+
+External Links
+--------------
+
+-  http://packages.profusion.mobi/codespell/ (download)
+-  http://git.profusion.mobi/cgit.cgi/lucas/codespell/ (git repository)
+-  https://github.com/lucasdemarchi/codespell (alternate git repository)
+-  http://en.wikipedia.org/wiki/Wikipedia:Lists_of_common_misspellings/For_machines
+-  http://grammar.yourdictionary.com/spelling-and-word-lists/misspelled.html
-- 
2.31.1



  reply	other threads:[~2021-09-22 12:14 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-22 12:10 [PATCH 0/3] rSTify SubmitAPatch, TrivialPatches, and SpellCheck wiki pages Kashyap Chamarthy
2021-09-22 12:10 ` Kashyap Chamarthy [this message]
2021-09-22 13:10   ` [PATCH 1/3] docs: rSTify the "SpellCheck" wiki Peter Maydell
2021-09-22 13:48     ` Kashyap Chamarthy
2021-09-22 12:10 ` [PATCH 2/3] docs: rSTify the "TrivialPatches" wiki Kashyap Chamarthy
2021-09-22 13:05   ` Philippe Mathieu-Daudé
2021-09-22 13:16     ` Kashyap Chamarthy
2021-09-22 13:18     ` Daniel P. Berrangé
2021-09-22 12:10 ` [PATCH 3/3] docs: rSTify the "SubmitAPatch" wiki Kashyap Chamarthy
2021-09-22 13:05 ` [PATCH 0/3] rSTify SubmitAPatch, TrivialPatches, and SpellCheck wiki pages Peter Maydell
2021-09-22 13:23   ` Kashyap Chamarthy
2021-09-28 17:31 ` Paolo Bonzini
2021-09-29  7:53   ` Kashyap Chamarthy
2021-10-05 14:01 ` Stefan Hajnoczi
2021-10-05 14:11   ` Kashyap Chamarthy
2021-10-05 14:24     ` Stefan Hajnoczi
2021-10-05 14:39       ` Kashyap Chamarthy
2021-10-05 15:07       ` Philippe Mathieu-Daudé
2021-10-05 15:37         ` Daniel P. Berrangé
2021-10-05 16:03           ` In-tree docs vs. Wiki [Was: Re: [PATCH 0/3] rSTify SubmitAPatch, TrivialPatches, and SpellCheck wiki pages] Kashyap Chamarthy
2021-10-05 16:06             ` Philippe Mathieu-Daudé

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=20210922121054.1458051-2-kchamart@redhat.com \
    --to=kchamart@redhat.com \
    --cc=eblake@redhat.com \
    --cc=jsnow@redhat.com \
    --cc=laurent@vivier.eu \
    --cc=mjt@tls.msk.ru \
    --cc=pbonzini@redhat.com \
    --cc=peter.maydell@linaro.org \
    --cc=qemu-devel@nongnu.org \
    --cc=stefanha@redhat.com \
    --cc=thuth@redhat.com \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.