[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 1/3] docs: rSTify the "SpellCheck" wiki
From: |
Kashyap Chamarthy |
Subject: |
[PATCH 1/3] docs: rSTify the "SpellCheck" wiki |
Date: |
Wed, 22 Sep 2021 14:10:52 +0200 |
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
- [PATCH 0/3] rSTify SubmitAPatch, TrivialPatches, and SpellCheck wiki pages, Kashyap Chamarthy, 2021/09/22
- [PATCH 1/3] docs: rSTify the "SpellCheck" wiki,
Kashyap Chamarthy <=
- [PATCH 2/3] docs: rSTify the "TrivialPatches" wiki, Kashyap Chamarthy, 2021/09/22
- [PATCH 3/3] docs: rSTify the "SubmitAPatch" wiki, Kashyap Chamarthy, 2021/09/22
- Re: [PATCH 0/3] rSTify SubmitAPatch, TrivialPatches, and SpellCheck wiki pages, Peter Maydell, 2021/09/22
- Re: [PATCH 0/3] rSTify SubmitAPatch, TrivialPatches, and SpellCheck wiki pages, Paolo Bonzini, 2021/09/28