GNU bug report logs - #75793
[PATCH] Remove leading '*' from docstrings in cc-vars.el

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 75793 in the body.
You can then email your comments to 75793 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 <stefankangas <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Cc: Alan Mackenzie <acm <at> muc.de>
Subject: [PATCH] Remove leading '*' from docstrings in cc-vars.el
Date: Thu, 23 Jan 2025 16:56:33 -0600

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

Severity: wishlist

Hi Alan,

Please find attached a minor cleanup that removes a leading '*'
character from some docstrings in CC Mode.  AFAIU, this is the '*' that
we used to have for user-variable docstrings.

I'm not sure if this list is still the preferred way to send CC Mode bug
reports, so please let me know if you prefer anything else.

Thanks!

[0001-Remove-leading-from-docstrings-in-cc-vars.el.patch (text/x-patch, attachment)]

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

From: Alan Mackenzie <acm <at> muc.de>
To: Stefan Kangas <stefankangas <at> gmail.com>
Cc: bug-gnu-emacs <at> gnu.org
Subject: Re: [PATCH] Remove leading '*' from docstrings in cc-vars.el
Date: Tue, 28 Jan 2025 12:28:06 +0000

Hello, Stefan.

On Thu, Jan 23, 2025 at 16:56:33 -0600, Stefan Kangas wrote:
> Severity: wishlist

> Hi Alan,

> Please find attached a minor cleanup that removes a leading '*'
> character from some docstrings in CC Mode.  AFAIU, this is the '*' that
> we used to have for user-variable docstrings.

Yes indeed.  Most of these have already been removed from CC Mode in
Emacs, just that last one had a line continuation to confound grep.

In stand alone CC Mode, there are still 47 such asterisks, which I'll
get rid of sometime.

> I'm not sure if this list is still the preferred way to send CC Mode bug
> reports, so please let me know if you prefer anything else.

Yes, bug-cc-mode <at> gnu.org is indeed my preferred list, though I will
still handle things sent to my personal address too.

> Thanks!

Thank you, too!

> From a170459b4a5a6531415efe1492474834b465c52c Mon Sep 17 00:00:00 2001
> From: Stefan Kangas <stefankangas <at> gmail.com>
> Date: Thu, 23 Jan 2025 23:49:52 +0100
> Subject: [PATCH] Remove leading '*' from docstrings in cc-vars.el
> 
> * lisp/progmodes/cc-vars.el (c-make-font-lock-extra-types-blurb):
> Remove leading '*' from generated docstrings.
> ---
>  lisp/progmodes/cc-vars.el | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/lisp/progmodes/cc-vars.el b/lisp/progmodes/cc-vars.el
> index 3c386eb07e9..0687801d69f 100644
> --- a/lisp/progmodes/cc-vars.el
> +++ b/lisp/progmodes/cc-vars.el
> @@ -1566,7 +1566,7 @@ 'c-extra-types-widget
>  
>  (defun c-make-font-lock-extra-types-blurb (mode1 mode2 example)
>    (concat "\
> -*List of extra types (aside from the type keywords) to recognize in "
> +List of extra types (aside from the type keywords) to recognize in "
>  mode1 " mode.
>  Each list item should be a regexp matching a single identifier.
>  " example "
> -- 
> 2.48.1
> 

-- 
Alan Mackenzie (Nuremberg, Germany).

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

From: Stefan Kangas <stefankangas <at> gmail.com>
To: Alan Mackenzie <acm <at> muc.de>
Cc: 75793-done <at> debbugs.gnu.org
Subject: Re: [PATCH] Remove leading '*' from docstrings in cc-vars.el
Date: Fri, 7 Feb 2025 13:31:01 -0800

Version: 31.1

Alan Mackenzie <acm <at> muc.de> writes:

> Yes indeed.  Most of these have already been removed from CC Mode in
> Emacs, just that last one had a line continuation to confound grep.
>
> In stand alone CC Mode, there are still 47 such asterisks, which I'll
> get rid of sometime.

Thanks, so I pushed this to Emacs master (commit 93206cbcea3).

I'm therefore closing this bug report.

Previous Next

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