GNU bug report logs - #72814
31.0.50; Add a variable controlling doxygen support in C/C++/Java?

Previous Next

Package: emacs;

Reported by: Yuan Fu <casouri <at> gmail.com>

Date: Mon, 26 Aug 2024 03:58:01 UTC

Severity: normal

Merged with 72815

Found in version 31.0.50

Done: Eli Zaretskii <eliz <at> gnu.org>

Bug is archived. No further changes may be made.

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

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

View this report as an mbox folder, status mbox, maintainer mbox


Report forwarded to mailto:eliz <at> gnu.org, vincenzo.pupillo <at> unimi.it, bug-gnu-emacs <at> gnu.org:
bug#72814; Package emacs. (Mon, 26 Aug 2024 03:58:01 GMT) Full text and rfc822 format available.

Acknowledgement sent to Yuan Fu <casouri <at> gmail.com>:
New bug report received and forwarded. Copy sent to mailto:eliz <at> gnu.org, vincenzo.pupillo <at> unimi.it, bug-gnu-emacs <at> gnu.org. (Mon, 26 Aug 2024 03:58:02 GMT) Full text and rfc822 format available.

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

From: Yuan Fu <casouri <at> gmail.com>
To: Bug Report Emacs <bug-gnu-emacs <at> gnu.org>
Subject: 31.0.50; Add a variable controlling doxygen support in C/C++/Java?
Date: Sun, 25 Aug 2024 20:56:31 -0700
X-Debbugs-CC: eliz <at> gnu.org <mailto:eliz <at> gnu.org>, vincenzo.pupillo <at> unimi.it

Should we add a custom option that controls whether to enable doxygen
support in c-ts-mode/c++-ts-mode/java-ts-mode?

Technically this isn’t a problem, since the doxygen support is only
enabled if there’s doxygen grammar on the system. But many people
(me) might install a grammar bundle that includes dozens of
grammars for convenience. Then the doxygen support would turn on when
the user doesn’t really intend to use it.

I propose we add custom options like c-ts-mode-enable-doxygen and set it
to t by default, so the default behavior is still to enable doxygen
support when the grammar for it exists, but people who don’t want to pay
for it can turn it off by setting the option to nil.

Yuan





Merged 72814 72815. Request was from Yuan Fu <casouri <at> gmail.com> to control <at> debbugs.gnu.org. (Tue, 27 Aug 2024 03:16:01 GMT) Full text and rfc822 format available.

Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#72814; Package emacs. (Tue, 27 Aug 2024 03:17:02 GMT) Full text and rfc822 format available.

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

From: Yuan Fu <casouri <at> gmail.com>
To: 72814 <at> debbugs.gnu.org
Cc: vincenzo.pupillo <at> unimi.it, eliz <at> gnu.org
Subject: Re: bug#72814: 31.0.50; Add a variable controlling doxygen support 
 in C/C++/Java?
Date: Mon, 26 Aug 2024 20:13:52 -0700
Yuan Fu <casouri <at> gmail.com> writes:

> X-Debbugs-CC: eliz <at> gnu.org <mailto:eliz <at> gnu.org>,
> vincenzo.pupillo <at> unimi.it
>
> Should we add a custom option that controls whether to enable doxygen
> support in c-ts-mode/c++-ts-mode/java-ts-mode?
>
> Technically this isn’t a problem, since the doxygen support is only
> enabled if there’s doxygen grammar on the system. But many people
> (me) might install a grammar bundle that includes dozens of
> grammars for convenience. Then the doxygen support would turn on when
> the user doesn’t really intend to use it.
>
> I propose we add custom options like c-ts-mode-enable-doxygen and set it
> to t by default, so the default behavior is still to enable doxygen
> support when the grammar for it exists, but people who don’t want to pay
> for it can turn it off by setting the option to nil.
>
> Yuan

Eli, WDYT?




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#72814; Package emacs. (Tue, 27 Aug 2024 07:39:02 GMT) Full text and rfc822 format available.

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

From: Vincenzo Pupillo <v.pupillo <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org, Yuan Fu <casouri <at> gmail.com>, 72814 <at> debbugs.gnu.org
Cc: eliz <at> gnu.org
Subject: Re: bug#72814: 31.0.50; Add a variable controlling doxygen support  in C/C++/Java?
Date: Tue, 27 Aug 2024 09:36:51 +0200
[Message part 1 (text/plain, inline)]
Sorry Yuan, the spam filter is aggressive on my work email and I didn't see your email. In early versions of php-ts-mode there were two variables to disable parser injection for html and phpdoc. When, thanks in part to your help, I was able to get indentation and font locking to work properly, I preferred to remove them because they seemed unnecessary.
c-ts-mode has font locking for comments itself, so it is fine to introduce this variable from my point of view.

Vincenzo 

Il 27 agosto 2024 05:13:52 CEST, Yuan Fu <casouri <at> gmail.com> ha scritto:
>
>Yuan Fu <casouri <at> gmail.com> writes:
>
>> X-Debbugs-CC: eliz <at> gnu.org <mailto:eliz <at> gnu.org>,
>> vincenzo.pupillo <at> unimi.it
>>
>> Should we add a custom option that controls whether to enable doxygen
>> support in c-ts-mode/c++-ts-mode/java-ts-mode?
>>
>> Technically this isn’t a problem, since the doxygen support is only
>> enabled if there’s doxygen grammar on the system. But many people
>> (me) might install a grammar bundle that includes dozens of
>> grammars for convenience. Then the doxygen support would turn on when
>> the user doesn’t really intend to use it.
>>
>> I propose we add custom options like c-ts-mode-enable-doxygen and set it
>> to t by default, so the default behavior is still to enable doxygen
>> support when the grammar for it exists, but people who don’t want to pay
>> for it can turn it off by setting the option to nil.
>>
>> Yuan
>
>Eli, WDYT?
>
>
>
[Message part 2 (text/html, inline)]

Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#72814; Package emacs. (Tue, 27 Aug 2024 07:39:02 GMT) Full text and rfc822 format available.

Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#72814; Package emacs. (Tue, 27 Aug 2024 12:24:01 GMT) Full text and rfc822 format available.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Yuan Fu <casouri <at> gmail.com>
Cc: 72814 <at> debbugs.gnu.org, vincenzo.pupillo <at> unimi.it
Subject: Re: bug#72814: 31.0.50; Add a variable controlling doxygen support 
 in C/C++/Java?
Date: Tue, 27 Aug 2024 15:22:16 +0300
> From: Yuan Fu <casouri <at> gmail.com>
> Date: Mon, 26 Aug 2024 20:13:52 -0700
> Cc: eliz <at> gnu.org,
>  vincenzo.pupillo <at> unimi.it
> 
> 
> Yuan Fu <casouri <at> gmail.com> writes:
> 
> > X-Debbugs-CC: eliz <at> gnu.org <mailto:eliz <at> gnu.org>,
> > vincenzo.pupillo <at> unimi.it
> >
> > Should we add a custom option that controls whether to enable doxygen
> > support in c-ts-mode/c++-ts-mode/java-ts-mode?
> >
> > Technically this isn’t a problem, since the doxygen support is only
> > enabled if there’s doxygen grammar on the system. But many people
> > (me) might install a grammar bundle that includes dozens of
> > grammars for convenience. Then the doxygen support would turn on when
> > the user doesn’t really intend to use it.
> >
> > I propose we add custom options like c-ts-mode-enable-doxygen and set it
> > to t by default, so the default behavior is still to enable doxygen
> > support when the grammar for it exists, but people who don’t want to pay
> > for it can turn it off by setting the option to nil.
> >
> > Yuan
> 
> Eli, WDYT?

I'm okay with such an option, but it should be careful to check
whether the corresponding grammar library is available, and offer a
user-friendly diagnostic if not.




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#72814; Package emacs. (Mon, 09 Sep 2024 09:52:02 GMT) Full text and rfc822 format available.

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

From: Vincenzo Pupillo <v.pupillo <at> gmail.com>
To: Yuan Fu <casouri <at> gmail.com>, bug-gnu-emacs <at> gnu.org
Cc: 72814 <at> debbugs.gnu.org, Eli Zaretskii <eliz <at> gnu.org>,
 vincenzo.pupillo <at> unimi.it
Subject: Re: bug#72814: 31.0.50;
 Add a variable controlling doxygen support  in C/C++/Java?
Date: Mon, 09 Sep 2024 11:50:59 +0200
[Message part 1 (text/plain, inline)]
In data martedì 27 agosto 2024 14:22:16 CEST, Eli Zaretskii ha scritto:
> > From: Yuan Fu <casouri <at> gmail.com>
> > Date: Mon, 26 Aug 2024 20:13:52 -0700
> > Cc: eliz <at> gnu.org,
> > 
> >  vincenzo.pupillo <at> unimi.it
> > 
> > Yuan Fu <casouri <at> gmail.com> writes:
> > > X-Debbugs-CC: eliz <at> gnu.org <mailto:eliz <at> gnu.org>,
> > > vincenzo.pupillo <at> unimi.it
> > > 
> > > Should we add a custom option that controls whether to enable doxygen
> > > support in c-ts-mode/c++-ts-mode/java-ts-mode?
> > > 
> > > Technically this isn’t a problem, since the doxygen support is only
> > > enabled if there’s doxygen grammar on the system. But many people
> > > (me) might install a grammar bundle that includes dozens of
> > > grammars for convenience. Then the doxygen support would turn on when
> > > the user doesn’t really intend to use it.
> > > 
> > > I propose we add custom options like c-ts-mode-enable-doxygen and set it
> > > to t by default, so the default behavior is still to enable doxygen
> > > support when the grammar for it exists, but people who don’t want to pay
> > > for it can turn it off by setting the option to nil.
> > > 
> > > Yuan
> > 
> > Eli, WDYT?
> 
> I'm okay with such an option, but it should be careful to check
> whether the corresponding grammar library is available, and offer a
> user-friendly diagnostic if not.

Try to take a look at this patch. Is it okay?

Vincenzo
[0001-Add-a-user-option-to-disable-Doxygen-syntax-highligh.patch (text/x-patch, attachment)]

Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#72814; Package emacs. (Mon, 09 Sep 2024 09:53:01 GMT) Full text and rfc822 format available.

Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#72814; Package emacs. (Wed, 11 Sep 2024 04:55:01 GMT) Full text and rfc822 format available.

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

From: Yuan Fu <casouri <at> gmail.com>
To: Vincenzo Pupillo <v.pupillo <at> gmail.com>
Cc: 72814 <at> debbugs.gnu.org, Bug Report Emacs <bug-gnu-emacs <at> gnu.org>,
 Eli Zaretskii <eliz <at> gnu.org>, vincenzo.pupillo <at> unimi.it
Subject: Re: bug#72814: 31.0.50; Add a variable controlling doxygen support 
 in C/C++/Java?
Date: Tue, 10 Sep 2024 21:53:32 -0700

> On Sep 9, 2024, at 2:50 AM, Vincenzo Pupillo <v.pupillo <at> gmail.com> wrote:
> 
> In data martedì 27 agosto 2024 14:22:16 CEST, Eli Zaretskii ha scritto:
>>> From: Yuan Fu <casouri <at> gmail.com>
>>> Date: Mon, 26 Aug 2024 20:13:52 -0700
>>> Cc: eliz <at> gnu.org,
>>> 
>>> vincenzo.pupillo <at> unimi.it
>>> 
>>> Yuan Fu <casouri <at> gmail.com> writes:
>>>> X-Debbugs-CC: eliz <at> gnu.org <mailto:eliz <at> gnu.org>,
>>>> vincenzo.pupillo <at> unimi.it
>>>> 
>>>> Should we add a custom option that controls whether to enable doxygen
>>>> support in c-ts-mode/c++-ts-mode/java-ts-mode?
>>>> 
>>>> Technically this isn’t a problem, since the doxygen support is only
>>>> enabled if there’s doxygen grammar on the system. But many people
>>>> (me) might install a grammar bundle that includes dozens of
>>>> grammars for convenience. Then the doxygen support would turn on when
>>>> the user doesn’t really intend to use it.
>>>> 
>>>> I propose we add custom options like c-ts-mode-enable-doxygen and set it
>>>> to t by default, so the default behavior is still to enable doxygen
>>>> support when the grammar for it exists, but people who don’t want to pay
>>>> for it can turn it off by setting the option to nil.
>>>> 
>>>> Yuan
>>> 
>>> Eli, WDYT?
>> 
>> I'm okay with such an option, but it should be careful to check
>> whether the corresponding grammar library is available, and offer a
>> user-friendly diagnostic if not.
> 
> Try to take a look at this patch. Is it okay?
> 
> Vincenzo
> <0001-Add-a-user-option-to-disable-Doxygen-syntax-highligh.patch>

Thanks for taking this up! I won’t signal a warning if doxygen grammar isn’t found. Imagine a user without doxygen grammar, and din’t change c-ts-mode-enable-doxygen: they’ll get a warning whenever they open a C file. We should either set c-ts-mode-enable-doxygen to nil by default, or not warn when doxygen grammar doesn’t exist. Otherwise, the patch looks good to me.

Yuan



Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#72814; Package emacs. (Wed, 11 Sep 2024 04:57:02 GMT) Full text and rfc822 format available.

Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#72814; Package emacs. (Wed, 11 Sep 2024 09:41:02 GMT) Full text and rfc822 format available.

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

From: Vincenzo Pupillo <v.pupillo <at> gmail.com>
To: Yuan Fu <casouri <at> gmail.com>, Eli Zaretskii <eliz <at> gnu.org>
Cc: 72814 <at> debbugs.gnu.org, Bug Report Emacs <bug-gnu-emacs <at> gnu.org>
Subject: Re: bug#72814: 31.0.50;
 Add a variable controlling doxygen support in C/C++/Java?
Date: Wed, 11 Sep 2024 11:40:17 +0200
In data mercoledì 11 settembre 2024 06:53:32 CEST, Yuan Fu ha scritto:
> 
> > On Sep 9, 2024, at 2:50 AM, Vincenzo Pupillo <v.pupillo <at> gmail.com> wrote:
> > 
> > In data martedì 27 agosto 2024 14:22:16 CEST, Eli Zaretskii ha scritto:
> >>> From: Yuan Fu <casouri <at> gmail.com>
> >>> Date: Mon, 26 Aug 2024 20:13:52 -0700
> >>> Cc: eliz <at> gnu.org,
> >>> 
> >>> vincenzo.pupillo <at> unimi.it
> >>> 
> >>> Yuan Fu <casouri <at> gmail.com> writes:
> >>>> X-Debbugs-CC: eliz <at> gnu.org <mailto:eliz <at> gnu.org>,
> >>>> vincenzo.pupillo <at> unimi.it
> >>>> 
> >>>> Should we add a custom option that controls whether to enable doxygen
> >>>> support in c-ts-mode/c++-ts-mode/java-ts-mode?
> >>>> 
> >>>> Technically this isn’t a problem, since the doxygen support is only
> >>>> enabled if there’s doxygen grammar on the system. But many people
> >>>> (me) might install a grammar bundle that includes dozens of
> >>>> grammars for convenience. Then the doxygen support would turn on when
> >>>> the user doesn’t really intend to use it.
> >>>> 
> >>>> I propose we add custom options like c-ts-mode-enable-doxygen and set it
> >>>> to t by default, so the default behavior is still to enable doxygen
> >>>> support when the grammar for it exists, but people who don’t want to pay
> >>>> for it can turn it off by setting the option to nil.
> >>>> 
> >>>> Yuan
> >>> 
> >>> Eli, WDYT?
> >> 
> >> I'm okay with such an option, but it should be careful to check
> >> whether the corresponding grammar library is available, and offer a
> >> user-friendly diagnostic if not.
> > 
> > Try to take a look at this patch. Is it okay?
> > 
> > Vincenzo
> > <0001-Add-a-user-option-to-disable-Doxygen-syntax-highligh.patch>
> 
> Thanks for taking this up! I won’t signal a warning if doxygen grammar isn’t found. Imagine a user without doxygen grammar, and din’t change c-ts-mode-enable-doxygen: they’ll get a warning whenever they open a C file. 
> We should either set c-ts-mode-enable-doxygen to nil by default, or not warn when doxygen grammar doesn’t exist. Otherwise, the patch looks good to me.

Okay, fine. But Eli said something different...
What do we do?

Vincenzo
> 
> Yuan
> 







Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#72814; Package emacs. (Wed, 11 Sep 2024 09:42:01 GMT) Full text and rfc822 format available.

Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#72814; Package emacs. (Wed, 11 Sep 2024 12:06:01 GMT) Full text and rfc822 format available.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Vincenzo Pupillo <v.pupillo <at> gmail.com>
Cc: 72814 <at> debbugs.gnu.org, casouri <at> gmail.com, bug-gnu-emacs <at> gnu.org
Subject: Re: bug#72814: 31.0.50;
 Add a variable controlling doxygen support in C/C++/Java?
Date: Wed, 11 Sep 2024 15:05:10 +0300
> From: Vincenzo Pupillo <v.pupillo <at> gmail.com>
> Cc: Bug Report Emacs <bug-gnu-emacs <at> gnu.org>, 72814 <at> debbugs.gnu.org
> Date: Wed, 11 Sep 2024 11:40:17 +0200
> 
> > Thanks for taking this up! I won’t signal a warning if doxygen grammar isn’t found. Imagine a user without doxygen grammar, and din’t change c-ts-mode-enable-doxygen: they’ll get a warning whenever they open a C file. 
> > We should either set c-ts-mode-enable-doxygen to nil by default, or not warn when doxygen grammar doesn’t exist. Otherwise, the patch looks good to me.
> 
> Okay, fine. But Eli said something different...

Not necessarily.  All I said was "issue a user-friendly diagnostic".
We could output the message into *Messages*, and do it only once per
Emacs session.




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#72814; Package emacs. (Wed, 11 Sep 2024 12:06:02 GMT) Full text and rfc822 format available.

Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#72814; Package emacs. (Thu, 12 Sep 2024 07:52:02 GMT) Full text and rfc822 format available.

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

From: Yuan Fu <casouri <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 72814 <at> debbugs.gnu.org, Bug Report Emacs <bug-gnu-emacs <at> gnu.org>,
 Vincenzo Pupillo <v.pupillo <at> gmail.com>
Subject: Re: bug#72814: 31.0.50; Add a variable controlling doxygen support in
 C/C++/Java?
Date: Thu, 12 Sep 2024 00:51:20 -0700

> On Sep 11, 2024, at 5:05 AM, Eli Zaretskii <eliz <at> gnu.org> wrote:
> 
>> From: Vincenzo Pupillo <v.pupillo <at> gmail.com>
>> Cc: Bug Report Emacs <bug-gnu-emacs <at> gnu.org>, 72814 <at> debbugs.gnu.org
>> Date: Wed, 11 Sep 2024 11:40:17 +0200
>> 
>>> Thanks for taking this up! I won’t signal a warning if doxygen grammar isn’t found. Imagine a user without doxygen grammar, and din’t change c-ts-mode-enable-doxygen: they’ll get a warning whenever they open a C file. 
>>> We should either set c-ts-mode-enable-doxygen to nil by default, or not warn when doxygen grammar doesn’t exist. Otherwise, the patch looks good to me.
>> 
>> Okay, fine. But Eli said something different...
> 
> Not necessarily.  All I said was "issue a user-friendly diagnostic".
> We could output the message into *Messages*, and do it only once per
> Emacs session.

Another idea: use tertiary value for c-ts-mode-enable-doxygen, t for enable (and issue warning if doxygen isn’t present), nil for enable if doxygen exists but don’t issue any warning, ‘disabled for disable. (I don’t think there’s a convention for the three values of tertiary toggle, is that right Eli?)

Yuan



Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#72814; Package emacs. (Thu, 12 Sep 2024 07:53:02 GMT) Full text and rfc822 format available.

Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#72814; Package emacs. (Thu, 12 Sep 2024 08:33:01 GMT) Full text and rfc822 format available.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Yuan Fu <casouri <at> gmail.com>
Cc: 72814 <at> debbugs.gnu.org, bug-gnu-emacs <at> gnu.org, v.pupillo <at> gmail.com
Subject: Re: bug#72814: 31.0.50; Add a variable controlling doxygen support in
 C/C++/Java?
Date: Thu, 12 Sep 2024 11:31:56 +0300
> From: Yuan Fu <casouri <at> gmail.com>
> Date: Thu, 12 Sep 2024 00:51:20 -0700
> Cc: Vincenzo Pupillo <v.pupillo <at> gmail.com>,
>  Bug Report Emacs <bug-gnu-emacs <at> gnu.org>,
>  72814 <at> debbugs.gnu.org
> 
> 
> 
> > On Sep 11, 2024, at 5:05 AM, Eli Zaretskii <eliz <at> gnu.org> wrote:
> > 
> >> From: Vincenzo Pupillo <v.pupillo <at> gmail.com>
> >> Cc: Bug Report Emacs <bug-gnu-emacs <at> gnu.org>, 72814 <at> debbugs.gnu.org
> >> Date: Wed, 11 Sep 2024 11:40:17 +0200
> >> 
> >>> Thanks for taking this up! I won’t signal a warning if doxygen grammar isn’t found. Imagine a user without doxygen grammar, and din’t change c-ts-mode-enable-doxygen: they’ll get a warning whenever they open a C file. 
> >>> We should either set c-ts-mode-enable-doxygen to nil by default, or not warn when doxygen grammar doesn’t exist. Otherwise, the patch looks good to me.
> >> 
> >> Okay, fine. But Eli said something different...
> > 
> > Not necessarily.  All I said was "issue a user-friendly diagnostic".
> > We could output the message into *Messages*, and do it only once per
> > Emacs session.
> 
> Another idea: use tertiary value for c-ts-mode-enable-doxygen, t for enable (and issue warning if doxygen isn’t present), nil for enable if doxygen exists but don’t issue any warning, ‘disabled for disable. (I don’t think there’s a convention for the three values of tertiary toggle, is that right Eli?)

That could also be OK, but I prefer something that does TRT by
default.




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#72814; Package emacs. (Thu, 12 Sep 2024 08:33:02 GMT) Full text and rfc822 format available.

Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#72814; Package emacs. (Sat, 14 Sep 2024 17:27:02 GMT) Full text and rfc822 format available.

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

From: Vincenzo Pupillo <v.pupillo <at> gmail.com>
To: Yuan Fu <casouri <at> gmail.com>, Eli Zaretskii <eliz <at> gnu.org>
Cc: 72814 <at> debbugs.gnu.org, bug-gnu-emacs <at> gnu.org
Subject: Re: bug#72814: 31.0.50;
 Add a variable controlling doxygen support in C/C++/Java?
Date: Sat, 14 Sep 2024 19:26:07 +0200
[Message part 1 (text/plain, inline)]
In data giovedì 12 settembre 2024 10:31:56 CEST, Eli Zaretskii ha scritto:
> > From: Yuan Fu <casouri <at> gmail.com>
> > Date: Thu, 12 Sep 2024 00:51:20 -0700
> > Cc: Vincenzo Pupillo <v.pupillo <at> gmail.com>,
> > 
> >  Bug Report Emacs <bug-gnu-emacs <at> gnu.org>,
> >  72814 <at> debbugs.gnu.org
> >  
> > > On Sep 11, 2024, at 5:05 AM, Eli Zaretskii <eliz <at> gnu.org> wrote:
> > >> From: Vincenzo Pupillo <v.pupillo <at> gmail.com>
> > >> Cc: Bug Report Emacs <bug-gnu-emacs <at> gnu.org>, 72814 <at> debbugs.gnu.org
> > >> Date: Wed, 11 Sep 2024 11:40:17 +0200
> > >> 
> > >>> Thanks for taking this up! I won’t signal a warning if doxygen grammar
> > >>> isn’t found. Imagine a user without doxygen grammar, and din’t change
> > >>> c-ts-mode-enable-doxygen: they’ll get a warning whenever they open a
> > >>> C file. We should either set c-ts-mode-enable-doxygen to nil by
> > >>> default, or not warn when doxygen grammar doesn’t exist. Otherwise,
> > >>> the patch looks good to me.> >> 
> > >> Okay, fine. But Eli said something different...
> > > 
> > > Not necessarily.  All I said was "issue a user-friendly diagnostic".
> > > We could output the message into *Messages*, and do it only once per
> > > Emacs session.
> > 
> > Another idea: use tertiary value for c-ts-mode-enable-doxygen, t for
> > enable (and issue warning if doxygen isn’t present), nil for enable if
> > doxygen exists but don’t issue any warning, ‘disabled for disable. (I
> > don’t think there’s a convention for the three values of tertiary toggle,
> > is that right Eli?)
> That could also be OK, but I prefer something that does TRT by
> default.

Ciao,
in this new version of the patch, as default, the *-ts-mode-enable-doxygen are 
set to nil, and issue a diagnostic (one per session) when Not-nil and if the  
grammar isn't present. It is OK?

Vincenzo
[0001-Add-a-user-option-to-enable-Doxygen-syntax-highlight.patch (text/x-patch, attachment)]

Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#72814; Package emacs. (Sat, 14 Sep 2024 17:28:02 GMT) Full text and rfc822 format available.

Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#72814; Package emacs. (Sat, 21 Sep 2024 09:45:02 GMT) Full text and rfc822 format available.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Vincenzo Pupillo <v.pupillo <at> gmail.com>
Cc: casouri <at> gmail.com, 72814-done <at> debbugs.gnu.org, bug-gnu-emacs <at> gnu.org
Subject: Re: bug#72814: 31.0.50;
 Add a variable controlling doxygen support in C/C++/Java?
Date: Sat, 21 Sep 2024 12:43:40 +0300
> From: Vincenzo Pupillo <v.pupillo <at> gmail.com>
> Cc: bug-gnu-emacs <at> gnu.org, 72814 <at> debbugs.gnu.org
> Date: Sat, 14 Sep 2024 19:26:07 +0200
> 
> > > Another idea: use tertiary value for c-ts-mode-enable-doxygen, t for
> > > enable (and issue warning if doxygen isn’t present), nil for enable if
> > > doxygen exists but don’t issue any warning, ‘disabled for disable. (I
> > > don’t think there’s a convention for the three values of tertiary toggle,
> > > is that right Eli?)
> > That could also be OK, but I prefer something that does TRT by
> > default.
> 
> Ciao,
> in this new version of the patch, as default, the *-ts-mode-enable-doxygen are 
> set to nil, and issue a diagnostic (one per session) when Not-nil and if the  
> grammar isn't present. It is OK?

Thanks, installed on master, and closing the bug.




Reply sent to Eli Zaretskii <eliz <at> gnu.org>:
You have taken responsibility. (Sat, 21 Sep 2024 09:45:03 GMT) Full text and rfc822 format available.

Notification sent to Yuan Fu <casouri <at> gmail.com>:
bug acknowledged by developer. (Sat, 21 Sep 2024 09:45:03 GMT) Full text and rfc822 format available.

Reply sent to Eli Zaretskii <eliz <at> gnu.org>:
You have taken responsibility. (Sat, 21 Sep 2024 09:45:03 GMT) Full text and rfc822 format available.

Notification sent to Yuan Fu <casouri <at> gmail.com>:
bug acknowledged by developer. (Sat, 21 Sep 2024 09:45:03 GMT) Full text and rfc822 format available.

Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#72814; Package emacs. (Sun, 22 Sep 2024 06:46:01 GMT) Full text and rfc822 format available.

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

From: Yuan Fu <casouri <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: Bug Report Emacs <bug-gnu-emacs <at> gnu.org>,
 Vincenzo Pupillo <v.pupillo <at> gmail.com>, 72814-done <at> debbugs.gnu.org
Subject: Re: bug#72814: 31.0.50; Add a variable controlling doxygen support in
 C/C++/Java?
Date: Sat, 21 Sep 2024 23:45:05 -0700

> On Sep 21, 2024, at 2:43 AM, Eli Zaretskii <eliz <at> gnu.org> wrote:
> 
>> From: Vincenzo Pupillo <v.pupillo <at> gmail.com>
>> Cc: bug-gnu-emacs <at> gnu.org, 72814 <at> debbugs.gnu.org
>> Date: Sat, 14 Sep 2024 19:26:07 +0200
>> 
>>>> Another idea: use tertiary value for c-ts-mode-enable-doxygen, t for
>>>> enable (and issue warning if doxygen isn’t present), nil for enable if
>>>> doxygen exists but don’t issue any warning, ‘disabled for disable. (I
>>>> don’t think there’s a convention for the three values of tertiary toggle,
>>>> is that right Eli?)
>>> That could also be OK, but I prefer something that does TRT by
>>> default.
>> 
>> Ciao,
>> in this new version of the patch, as default, the *-ts-mode-enable-doxygen are 
>> set to nil, and issue a diagnostic (one per session) when Not-nil and if the  
>> grammar isn't present. It is OK?
> 
> Thanks, installed on master, and closing the bug.

Thanks to you both!





Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#72814; Package emacs. (Sun, 22 Sep 2024 06:47:02 GMT) Full text and rfc822 format available.

bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Sun, 20 Oct 2024 11:24:06 GMT) Full text and rfc822 format available.

This bug report was last modified 242 days ago.

Previous Next


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