GNU bug report logs - #38583
[PATCH] 27.0.50; Add unattended spell-checking to checkdoc

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 38583 in the body.
You can then email your comments to 38583 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Damien Cassou <damien <at> cassou.me>
To: bug-gnu-emacs <at> gnu.org
Cc: Alex Branham <alex.branham <at> gmail.com>, Paul Eggert <eggert <at> cs.ucla.edu>,
 Ken Stevens <k.stevens <at> ieee.org>, Lars Ingebrigtsen <larsi <at> gnus.org>,
 "Eric M. Ludlam" <zappo <at> gnu.org>, Eli Zaretskii <eliz <at> gnu.org>
Subject: [PATCH] 27.0.50; Add unattended spell-checking to checkdoc
Date: Thu, 12 Dec 2019 22:26:35 +0100

[Message part 1 (text/plain, inline)]

This series of patches makes checkdoc capable of spell-checking even
when the user isn't using it interactively. When TAKE-NOTES is non-nil,
checkdoc will run spell-checking (with ispell) and report spelling
mistakes.

Damien Cassou (5):
  Add function `ispell-correct-p`
  Fix indentation of `checkdoc-ispell-docstring-engine`
  Cleanup of `checkdoc-ispell-docstring-engine`
  Properly initialize ispell in checkdoc
  Add unattended spell-checking to checkdoc

 lisp/emacs-lisp/checkdoc.el | 114 ++++++++++++++++++++----------------
 lisp/textmodes/ispell.el    |  46 +++++++++++----
 2 files changed, 98 insertions(+), 62 deletions(-)

-- 
Damien Cassou

"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill

[0001-Add-function-ispell-correct-p.patch (text/x-patch, attachment)]

[0002-Fix-indentation-of-checkdoc-ispell-docstring-engine.patch (text/x-patch, attachment)]

[0003-Cleanup-of-checkdoc-ispell-docstring-engine.patch (text/x-patch, attachment)]

[0004-Properly-initialize-ispell-in-checkdoc.patch (text/x-patch, attachment)]

[0005-Add-unattended-spell-checking-to-checkdoc.patch (text/x-patch, attachment)]

Message #8 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Damien Cassou <damien <at> cassou.me>
Cc: alex.branham <at> gmail.com, eggert <at> cs.ucla.edu, k.stevens <at> ieee.org,
 bug-gnu-emacs <at> gnu.org, larsi <at> gnus.org, zappo <at> gnu.org
Subject: Re: [PATCH] 27.0.50; Add unattended spell-checking to checkdoc
Date: Fri, 13 Dec 2019 11:05:34 +0200

> From: Damien Cassou <damien <at> cassou.me>
> Cc: "Ken Stevens" <k.stevens <at> ieee.org>, "Eric M. Ludlam" <zappo <at> gnu.org>,
>  "Alex Branham" <alex.branham <at> gmail.com>, "Lars Ingebrigtsen"
>  <larsi <at> gnus.org>, "Paul Eggert" <eggert <at> cs.ucla.edu>, "Eli Zaretskii"
>  <eliz <at> gnu.org>
> Date: Thu, 12 Dec 2019 22:26:35 +0100
> 
> This series of patches makes checkdoc capable of spell-checking even
> when the user isn't using it interactively. When TAKE-NOTES is non-nil,
> checkdoc will run spell-checking (with ispell) and report spelling
> mistakes.

Thanks.

What happens if none of the spellers supported by ispell.el is
installed on the user's system?

Message #11 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Damien Cassou <damien <at> cassou.me>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: alex.branham <at> gmail.com, eggert <at> cs.ucla.edu, k.stevens <at> ieee.org,
 bug-gnu-emacs <at> gnu.org, larsi <at> gnus.org, zappo <at> gnu.org
Subject: Re: [PATCH] 27.0.50; Add unattended spell-checking to checkdoc
Date: Fri, 13 Dec 2019 20:53:43 +0100

Eli Zaretskii <eliz <at> gnu.org> writes:
> What happens if none of the spellers supported by ispell.el is
> installed on the user's system?

Starting new Ispell process ispell with default dictionary... \ 
Buffer xxx has no process

Emacs exit status is 255 in this case.


-- 
Damien Cassou

"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill

Message #14 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Damien Cassou <damien <at> cassou.me>
Cc: alex.branham <at> gmail.com, eggert <at> cs.ucla.edu, k.stevens <at> ieee.org,
 bug-gnu-emacs <at> gnu.org, larsi <at> gnus.org, zappo <at> gnu.org
Subject: Re: [PATCH] 27.0.50; Add unattended spell-checking to checkdoc
Date: Fri, 13 Dec 2019 21:59:28 +0200

> From: Damien Cassou <damien <at> cassou.me>
> Cc: bug-gnu-emacs <at> gnu.org, k.stevens <at> ieee.org, zappo <at> gnu.org, alex.branham <at> gmail.com, larsi <at> gnus.org, eggert <at> cs.ucla.edu
> Date: Fri, 13 Dec 2019 20:53:43 +0100
> 
> Eli Zaretskii <eliz <at> gnu.org> writes:
> > What happens if none of the spellers supported by ispell.el is
> > installed on the user's system?
> 
> Starting new Ispell process ispell with default dictionary... \ 
> Buffer xxx has no process
> 
> Emacs exit status is 255 in this case.

Can we check this up front, and display some user-friendly message to
the effect that spell-checking cannot be done?

Message #17 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Damien Cassou <damien <at> cassou.me>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: alex.branham <at> gmail.com, eggert <at> cs.ucla.edu, k.stevens <at> ieee.org,
 bug-gnu-emacs <at> gnu.org, larsi <at> gnus.org, zappo <at> gnu.org
Subject: Re: [PATCH] 27.0.50; Add unattended spell-checking to checkdoc
Date: Fri, 27 Dec 2019 12:51:42 +0100

[Message part 1 (text/plain, inline)]

Hi Eli,

Eli Zaretskii <eliz <at> gnu.org> writes:
>> Eli Zaretskii <eliz <at> gnu.org> writes:
>> > What happens if none of the spellers supported by ispell.el is
>> > installed on the user's system?
>> 
>> Starting new Ispell process ispell with default dictionary... \ 
>> Buffer xxx has no process
>> 
>> Emacs exit status is 255 in this case.
>
> Can we check this up front, and display some user-friendly message to
> the effect that spell-checking cannot be done?

Here is an additional patch for the series to answer your request.

If you believe the patch series is too large to be reviewed, I can split
it in several smaller ones.

-- 
Damien Cassou

"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill

[0006-Improve-error-message-when-no-spellchecker-can-be-fo.patch (text/x-patch, attachment)]

Message #20 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Damien Cassou <damien <at> cassou.me>
Cc: alex.branham <at> gmail.com, eggert <at> cs.ucla.edu, k.stevens <at> ieee.org,
 bug-gnu-emacs <at> gnu.org, larsi <at> gnus.org, zappo <at> gnu.org
Subject: Re: [PATCH] 27.0.50; Add unattended spell-checking to checkdoc
Date: Fri, 27 Dec 2019 16:08:08 +0200

> From: Damien Cassou <damien <at> cassou.me>
> Cc: bug-gnu-emacs <at> gnu.org, k.stevens <at> ieee.org, zappo <at> gnu.org,
>  alex.branham <at> gmail.com, larsi <at> gnus.org, eggert <at> cs.ucla.edu
> Date: Fri, 27 Dec 2019 12:51:42 +0100
> 
> > Can we check this up front, and display some user-friendly message to
> > the effect that spell-checking cannot be done?
> 
> Here is an additional patch for the series to answer your request.

You mean, this is in addition to the previous patches?  If so, I'd
prefer a single patch.

Thanks.

Message #23 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Damien Cassou <damien <at> cassou.me>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: alex.branham <at> gmail.com, eggert <at> cs.ucla.edu, k.stevens <at> ieee.org,
 bug-gnu-emacs <at> gnu.org, larsi <at> gnus.org, zappo <at> gnu.org
Subject: Re: [PATCH] 27.0.50; Add unattended spell-checking to checkdoc
Date: Fri, 27 Dec 2019 15:43:19 +0100

[Message part 1 (text/plain, inline)]

Eli Zaretskii <eliz <at> gnu.org> writes:
> You mean, this is in addition to the previous patches?  If so, I'd
> prefer a single patch.

you want all the changes merged into a single patch? This seems much
harder to review but here it is.

-- 
Damien Cassou

"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill

[0001-Add-unattended-spell-checking-to-checkdoc.patch (text/x-patch, attachment)]

Message #26 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Damien Cassou <damien <at> cassou.me>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: alex.branham <at> gmail.com, eggert <at> cs.ucla.edu, k.stevens <at> ieee.org,
 bug-gnu-emacs <at> gnu.org, larsi <at> gnus.org, zappo <at> gnu.org
Subject: Re: [PATCH] 27.0.50; Add unattended spell-checking to checkdoc
Date: Sat, 11 Jan 2020 12:49:17 +0100

Damien Cassou <damien <at> cassou.me> writes:

> Eli Zaretskii <eliz <at> gnu.org> writes:
>> You mean, this is in addition to the previous patches?  If so, I'd
>> prefer a single patch.
>
> you want all the changes merged into a single patch? This seems much
> harder to review but here it is.

any news?

-- 
Damien Cassou

"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill

Message #29 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Damien Cassou <damien <at> cassou.me>
Cc: alex.branham <at> gmail.com, eggert <at> cs.ucla.edu, k.stevens <at> ieee.org,
 bug-gnu-emacs <at> gnu.org, larsi <at> gnus.org, zappo <at> gnu.org
Subject: Re: [PATCH] 27.0.50; Add unattended spell-checking to checkdoc
Date: Sat, 11 Jan 2020 14:26:16 +0200

> From: Damien Cassou <damien <at> cassou.me>
> Cc: bug-gnu-emacs <at> gnu.org, k.stevens <at> ieee.org, zappo <at> gnu.org,
>  alex.branham <at> gmail.com, larsi <at> gnus.org, eggert <at> cs.ucla.edu
> Date: Sat, 11 Jan 2020 12:49:17 +0100
> 
> Damien Cassou <damien <at> cassou.me> writes:
> 
> > Eli Zaretskii <eliz <at> gnu.org> writes:
> >> You mean, this is in addition to the previous patches?  If so, I'd
> >> prefer a single patch.
> >
> > you want all the changes merged into a single patch? This seems much
> > harder to review but here it is.
> 
> any news?

Sorry, it fell through the cracks.

However, I was about to push it now, but compiling the modified
version generates warnings:

    ELC      emacs-lisp/checkdoc.elc

  In checkdoc-ispell-docstring-engine:
  emacs-lisp/checkdoc.el:2161:47:Warning: reference to free variable
      `ispell-format-word-function'
  emacs-lisp/checkdoc.el:2162:62:Warning: reference to free variable
      `ispell-program-name'
  emacs-lisp/checkdoc.el:2163:42:Warning: reference to free variable
      `ispell-current-dictionary'

  In end of data:
  emacs-lisp/checkdoc.el:2714:1:Warning: the following functions are not known
      to be defined: ispell-set-spellchecker-params,
      ispell-accept-buffer-local-defs, ispell-correct-p

Could you please augment the patch so that these warnings are avoided?

Also, please mention the bug number in the commit log message.

TIA

Message #32 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Damien Cassou <damien <at> cassou.me>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: alex.branham <at> gmail.com, eggert <at> cs.ucla.edu, k.stevens <at> ieee.org,
 bug-gnu-emacs <at> gnu.org, larsi <at> gnus.org, zappo <at> gnu.org
Subject: Re: [PATCH] 27.0.50; Add unattended spell-checking to checkdoc
Date: Mon, 13 Jan 2020 06:19:56 +0100

[Message part 1 (text/plain, inline)]

Eli Zaretskii <eliz <at> gnu.org> writes:
> Sorry, it fell through the cracks.


no problem.


> However, I was about to push it now, but compiling the modified
> version generates warnings: […]
>
> Could you please augment the patch so that these warnings are avoided?


fixed


> Also, please mention the bug number in the commit log message.


fixed

-- 
Damien Cassou

"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill

[0001-Add-unattended-spell-checking-to-checkdoc.patch (text/x-patch, attachment)]

Message #37 received at 38583-done <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Damien Cassou <damien <at> cassou.me>
Cc: alex.branham <at> gmail.com, eggert <at> cs.ucla.edu, k.stevens <at> ieee.org,
 38583-done <at> debbugs.gnu.org, larsi <at> gnus.org, zappo <at> gnu.org
Subject: Re: [PATCH] 27.0.50; Add unattended spell-checking to checkdoc
Date: Thu, 16 Jan 2020 20:43:55 +0200

> From: Damien Cassou <damien <at> cassou.me>
> Cc: bug-gnu-emacs <at> gnu.org, k.stevens <at> ieee.org, zappo <at> gnu.org,
>  alex.branham <at> gmail.com, larsi <at> gnus.org, eggert <at> cs.ucla.edu
> Date: Mon, 13 Jan 2020 06:19:56 +0100
> 
> >From 46df39d2f7ddfe79dd55d8342ea20a2dc17ac31c Mon Sep 17 00:00:00 2001
> From: Damien Cassou <damien <at> cassou.me>
> Date: Fri, 27 Dec 2019 15:35:52 +0100
> Subject: [PATCH] Add unattended spell-checking to checkdoc

Thanks, I've now pushed this to the master branch.

Sorry for the delays and thanks for persevering.

Message #40 received at 38583-done <at> debbugs.gnu.org (full text, mbox):

From: Damien Cassou <damien <at> cassou.me>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: alex.branham <at> gmail.com, eggert <at> cs.ucla.edu, k.stevens <at> ieee.org,
 38583-done <at> debbugs.gnu.org, larsi <at> gnus.org, zappo <at> gnu.org
Subject: Re: [PATCH] 27.0.50; Add unattended spell-checking to checkdoc
Date: Thu, 16 Jan 2020 22:07:33 +0100

Hi Eli,

Eli Zaretskii <eliz <at> gnu.org> writes:
> Thanks, I've now pushed this to the master branch.
>
> Sorry for the delays and thanks for persevering.

thank you very much. Is it too late for Emacs 27?

Best,

-- 
Damien Cassou

"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill

Message #43 received at 38583-done <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Damien Cassou <damien <at> cassou.me>
Cc: alex.branham <at> gmail.com, eggert <at> cs.ucla.edu, k.stevens <at> ieee.org,
 38583-done <at> debbugs.gnu.org, larsi <at> gnus.org, zappo <at> gnu.org
Subject: Re: [PATCH] 27.0.50; Add unattended spell-checking to checkdoc
Date: Fri, 17 Jan 2020 09:59:17 +0200

> From: Damien Cassou <damien <at> cassou.me>
> Cc: 38583-done <at> debbugs.gnu.org, k.stevens <at> ieee.org, zappo <at> gnu.org,
>  alex.branham <at> gmail.com, larsi <at> gnus.org, eggert <at> cs.ucla.edu
> Date: Thu, 16 Jan 2020 22:07:33 +0100
> 
> Eli Zaretskii <eliz <at> gnu.org> writes:
> > Thanks, I've now pushed this to the master branch.
> >
> > Sorry for the delays and thanks for persevering.
> 
> thank you very much. Is it too late for Emacs 27?

In general, yes.  But you can try convincing me that it is so
important to have in Emacs 27 that we should make an exception.  I
considered this, and concluded that it's a minor convenience feature.
But maybe I'm missing something?

Message #46 received at 38583-done <at> debbugs.gnu.org (full text, mbox):

From: Damien Cassou <damien <at> cassou.me>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: alex.branham <at> gmail.com, eggert <at> cs.ucla.edu, k.stevens <at> ieee.org,
 38583-done <at> debbugs.gnu.org, larsi <at> gnus.org, zappo <at> gnu.org
Subject: Re: [PATCH] 27.0.50; Add unattended spell-checking to checkdoc
Date: Fri, 17 Jan 2020 10:06:09 +0100

Eli Zaretskii <eliz <at> gnu.org> writes:
> In general, yes.  But you can try convincing me that it is so
> important to have in Emacs 27 that we should make an exception.  I
> considered this, and concluded that it's a minor convenience feature.
> But maybe I'm missing something?

Integrating into Emacs 27 late in the process is risky because my code
could have introduced subtle bugs inside checkdoc and I would not like
to be responsible for a delay in the release.  That being said and
checkdoc being automatically activated by flycheck (which I believe many
people use), I think we will find bugs in my code quite fast if there
are any.  Moreover, I think that improving the overall quality of Emacs
code is important and every little step in this direction would be
helpful.

I'm not sure this is convincing enough but I would have tried :-D.

FYI, this work on checkdoc is part of a larger piece of work I've
started some years ago on improving the quality of Emacs packages.  Here
are some of my activities in this area:

- opening issues and sending patches on Emacs core regarding checkdoc
  (e.g., this one, bug#37063, bug#37034);

- giving very detailed reviews of packages sent to melpa (e.g.,
  https://github.com/melpa/melpa/pull/5451);

- rewriting melpa's CONTRIBUTING.org from scratch
  (https://github.com/melpa/melpa/blob/master/CONTRIBUTING.org);

- collaborating with emake's developer
  (https://github.com/vermiculus/emake.el/pull/8);

- writing makel (https://gitea.petton.fr/DamienCassou/makel);

- doing a conference on the subject at EmacsConf 2019
  (https://media.emacsconf.org/2019/16.html);

- prototyping a linting engine for everyone to easily write lint rules
  (https://gitlab.com/lintel/lintel).



-- 
Damien Cassou

"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill

Message #49 received at 38583 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Damien Cassou <damien <at> cassou.me>
Cc: alex.branham <at> gmail.com, eggert <at> cs.ucla.edu, k.stevens <at> ieee.org,
 larsi <at> gnus.org, zappo <at> gnu.org, 38583 <at> debbugs.gnu.org
Subject: Re: [PATCH] 27.0.50; Add unattended spell-checking to checkdoc
Date: Fri, 17 Jan 2020 11:49:56 +0200

> From: Damien Cassou <damien <at> cassou.me>
> Cc: 38583-done <at> debbugs.gnu.org, k.stevens <at> ieee.org, zappo <at> gnu.org,
>  alex.branham <at> gmail.com, larsi <at> gnus.org, eggert <at> cs.ucla.edu
> Date: Fri, 17 Jan 2020 10:06:09 +0100
> 
> Eli Zaretskii <eliz <at> gnu.org> writes:
> > In general, yes.  But you can try convincing me that it is so
> > important to have in Emacs 27 that we should make an exception.  I
> > considered this, and concluded that it's a minor convenience feature.
> > But maybe I'm missing something?
> 
> Integrating into Emacs 27 late in the process is risky because my code
> could have introduced subtle bugs inside checkdoc and I would not like
> to be responsible for a delay in the release.  That being said and
> checkdoc being automatically activated by flycheck (which I believe many
> people use), I think we will find bugs in my code quite fast if there
> are any.  Moreover, I think that improving the overall quality of Emacs
> code is important and every little step in this direction would be
> helpful.
> 
> I'm not sure this is convincing enough but I would have tried :-D.

OK, I've cherry-picked this to the release branch, mainly because it
narrowly missed the branching due to delays in our review of the
patch.

> FYI, this work on checkdoc is part of a larger piece of work I've
> started some years ago on improving the quality of Emacs packages.  Here
> are some of my activities in this area:

Thank you for your work on this.

Message #52 received at 38583 <at> debbugs.gnu.org (full text, mbox):

From: Damien Cassou <damien <at> cassou.me>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: alex.branham <at> gmail.com, eggert <at> cs.ucla.edu, k.stevens <at> ieee.org,
 larsi <at> gnus.org, zappo <at> gnu.org, 38583 <at> debbugs.gnu.org
Subject: Re: [PATCH] 27.0.50; Add unattended spell-checking to checkdoc
Date: Fri, 17 Jan 2020 11:35:47 +0100

Eli Zaretskii <eliz <at> gnu.org> writes:
> OK, I've cherry-picked this to the release branch, mainly because it
> narrowly missed the branching due to delays in our review of the
> patch.

thank you!

-- 
Damien Cassou

"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.