GNU bug report logs - #35994
Remove leading '*' from defcustom docstring todo considered done

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 35994 in the body.
You can then email your comments to 35994 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: Stefan Kangas <stefan <at> marxist.se>
To: bug-gnu-emacs <at> gnu.org
Subject: Remove leading '*' from defcustom docstring todo considered done
Date: Wed, 29 May 2019 19:55:01 +0200

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

I looked into the following item in etc/TODO:

> ** Remove any leading '*'s from defcustom doc-strings.
> [done?] [A lot of them are in CC Mode.]

I couldn't find one example.  Therefore, I propose that this should be
considered done.  I've attached a patch that removes the TODO.

I carried out the following steps, in case anyone wants to verify:

1. find . -type f -name "*.el" -exec grep -Hn -A20 "(defcustom" {} \; > output
2. grep '\*' output > output.filtered
3. Checked output.filtered manually (<< least fun step)

I'm sure there's a better way to do this, but I couldn't be bothered to think of
one.

Thanks,
Stefan Kangas

[0001-etc-TODO-Remove-done-TODO-to-remove-leading-from-def.patch (application/octet-stream, attachment)]

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

From: "Basil L. Contovounesios" <contovob <at> tcd.ie>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: 35994 <at> debbugs.gnu.org
Subject: Re: bug#35994: Remove leading '*' from defcustom docstring todo
 considered done
Date: Thu, 30 May 2019 02:48:49 +0100

severity 35994 minor
quit

Stefan Kangas <stefan <at> marxist.se> writes:

> I looked into the following item in etc/TODO:
>
>> ** Remove any leading '*'s from defcustom doc-strings.
>> [done?] [A lot of them are in CC Mode.]
>
> I couldn't find one example.  Therefore, I propose that this should be
> considered done.  I've attached a patch that removes the TODO.
>
> I carried out the following steps, in case anyone wants to verify:
>
> 1. find . -type f -name "*.el" -exec grep -Hn -A20 "(defcustom" {} \; > output
> 2. grep '\*' output > output.filtered
> 3. Checked output.filtered manually (<< least fun step)

There is also at least one defface (ibuffer-locked-buffer), and the
defvars in lisp/obsolete/cc-compat.el (I just did a quick rgrep '^  "\*').

Thanks,

-- 
Basil

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

From: Stefan Kangas <stefan <at> marxist.se>
To: "Basil L. Contovounesios" <contovob <at> tcd.ie>
Cc: 35994 <at> debbugs.gnu.org
Subject: Re: bug#35994: Remove leading '*' from defcustom docstring todo
 considered done
Date: Mon, 3 Jun 2019 02:43:59 +0200

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

Basil L. Contovounesios <contovob <at> tcd.ie> writes:
> There is also at least one defface (ibuffer-locked-buffer), and the

Please find attached an updated patch fixing this - thanks.

> defvars in lisp/obsolete/cc-compat.el (I just did a quick rgrep '^  "\*').

This is related to the TODO:

 ** Convert all defvars with leading '*' in the doc-strings into defcustoms
  of appropriate :type and :group.

I have attached a second patch which fixes this TODO item.

I didn't bother converting the defvar cases in lisp/obsolete/cc-compat.el to
defcustom since I don't feel like it's a good idea to expose this obsolete code
to the user more than necessary.  We should let it rest in peace. What do you
think?

Thanks,
Stefan Kangas

[0002-Fix-TODO-to-convert-defvar-with-leading-to-defcustom.patch (application/octet-stream, attachment)]

[0001-Fix-TODO-to-remove-leading-from-defcustom.patch (application/octet-stream, attachment)]

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: contovob <at> tcd.ie, 35994-done <at> debbugs.gnu.org
Subject: Re: bug#35994: Remove leading '*' from defcustom docstring todo
 considered done
Date: Sun, 09 Jun 2019 10:12:47 +0300

> From: Stefan Kangas <stefan <at> marxist.se>
> Date: Mon, 3 Jun 2019 02:43:59 +0200
> Cc: 35994 <at> debbugs.gnu.org
> 
> Basil L. Contovounesios <contovob <at> tcd.ie> writes:
> > There is also at least one defface (ibuffer-locked-buffer), and the
> 
> Please find attached an updated patch fixing this - thanks.
> 
> > defvars in lisp/obsolete/cc-compat.el (I just did a quick rgrep '^  "\*').
> 
> This is related to the TODO:
> 
>  ** Convert all defvars with leading '*' in the doc-strings into defcustoms
>   of appropriate :type and :group.
> 
> I have attached a second patch which fixes this TODO item.

Thanks, I pushed this to the master branch.

Please in the future, if you send several patches that change the same
files, be sure to arrange them in the order you made the changes,
because otherwise they might fail to apply.  In this case you sent the
patches in the reverse order; I was lucky to be able to figure out
that they need to be applied in reverse.

(In general, if you change the same files for reasons that are closely
related, like in this case, sending a single patch makes the job of
installing easier.)

Previous Next

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