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

On Wed, Sep 22, 2021 at 02:10:43PM +0100, Peter Maydell wrote:
> On Wed, 22 Sept 2021 at 13:11, Kashyap Chamarthy <kchamart@redhat.com> wrote:

[...]

> > +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.
> 
> This command doesn't actually work, because there is no
> scripts/codespell.exclude in the source tree. It also
> assumes you have a ~/share/codespell/dictionary.txt in your
> home directory.
> 
> I think Stefan proposed a patch adding the excludelist file to
> the source repository back when he wrote this wiki page a decade
> ago, but it did not get through code review.

Thanks for catching it.  I couldn't find the unmerged
'codespell.exclude' from my searches online.  I don't know if it still
makes sense to include such a file.  But regardless, 'codespell' is
useful on its own.  

In v2, I can nuke that command altogether, and link to the README of
upstream 'codespell':

    https://github.com/codespell-project/codespell

I'll also edit the paragraph that talks about installing the the tool in
$HOME directory -- it's no longer required; many major distros packaged
it.  At least Debian, Ubuntu, and Fedora do (as 'codespell'), and the
dictionary file gets installed under:

    $> rpm -ql codespell | grep dictionary
    /usr/lib/python3.9/site-packages/codespell_lib/data/dictionary.txt
    /usr/lib/python3.9/site-packages/codespell_lib/data/dictionary_code.txt
    /usr/lib/python3.9/site-packages/codespell_lib/data/dictionary_en-GB_to_en-US.txt
    /usr/lib/python3.9/site-packages/codespell_lib/data/dictionary_informal.txt
    /usr/lib/python3.9/site-packages/codespell_lib/data/dictionary_names.txt
    /usr/lib/python3.9/site-packages/codespell_lib/data/dictionary_rare.txt
    /usr/lib/python3.9/site-packages/codespell_lib/data/dictionary_usage.txt

I'll also link to 'my-spell' from Alex Bennée, for Emacs users: 
https://github.com/stsquad/my-emacs-stuff/blob/master/my-spell.el

-- 
/kashyap



  reply	other threads:[~2021-09-22 13:53 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 ` [PATCH 1/3] docs: rSTify the "SpellCheck" wiki Kashyap Chamarthy
2021-09-22 13:10   ` Peter Maydell
2021-09-22 13:48     ` Kashyap Chamarthy [this message]
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=YUs0SB3SC/XdpaXC@paraplu.home \
    --to=kchamart@redhat.com \
    --cc=alex.bennee@linaro.org \
    --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.