| Message ID | 20211019090344.3054300-3-kchamart@redhat.com |
|---|---|
| State | New |
| Headers | show |
| Series | rSTify contribution-related wiki pages | expand |
On 10/19/21 11:03, Kashyap Chamarthy wrote: > 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 Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
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
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