[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v2 2/6] docs: rSTify the "SpellCheck" wiki
From: |
Kashyap Chamarthy |
Subject: |
[PATCH v2 2/6] docs: rSTify the "SpellCheck" wiki |
Date: |
Tue, 19 Oct 2021 11:03:40 +0200 |
The original wiki is here[1]. I converted by copying the wiki source
into a .wiki file and convert to rST using `pandoc`:
$ pandoc -f Mediawiki -t rst spell-check.wiki -o spell-check.rst
As part of this rST converstion, I've removed the dated and `codespell`
invocations, and linked to the GitHub repo. And cleaned up a couple of
external URLs.
[1] https://wiki.qemu.org/Contribute/SpellCheck
Signed-off-by: Kashyap Chamarthy <kchamart@redhat.com>
---
docs/devel/spell-check.rst | 20 ++++++++++++++++++++
1 file changed, 20 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..61275b73c2
--- /dev/null
+++ b/docs/devel/spell-check.rst
@@ -0,0 +1,20 @@
+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 <https://github.com/codespell-project/codespell>`__ is a
+Python script which detects (and optionally fixes) the most common
+spelling bugs. It is packaged for most common Linux distributions.
+
+.. _external_links:
+
+External Links
+--------------
+
+- A spell-check tool for Emacs users:
+ https://github.com/stsquad/my-emacs-stuff/blob/master/my-spell.el
+-
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
- [PATCH v2 0/6] rSTify contribution-related wiki pages, Kashyap Chamarthy, 2021/10/19
- [PATCH v2 2/6] docs: rSTify the "SpellCheck" wiki,
Kashyap Chamarthy <=
- [PATCH v2 1/6] docs: rSTify the "TrivialPatches" wiki, Kashyap Chamarthy, 2021/10/19
- [PATCH v2 4/6] docs: rSTify the "SubmitAPullRequest" wiki, Kashyap Chamarthy, 2021/10/19
- [PATCH v2 3/6] docs: rSTify the "KeySigningParty" wiki, Kashyap Chamarthy, 2021/10/19
- [PATCH v2 6/6] docs/devel: Update the rST index file, Kashyap Chamarthy, 2021/10/19
- [PATCH v2 5/6] docs: rSTify the "SubmitAPatch" wiki, Kashyap Chamarthy, 2021/10/19
- Re: [PATCH v2 0/6] rSTify contribution-related wiki pages, Kashyap Chamarthy, 2021/10/19