GNU bug report logs - #52342
[PATCH] Add Texinfo support for Flymake

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 52342 in the body.
You can then email your comments to 52342 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: Okamsn <okamsn <at> protonmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: [PATCH] Add Texinfo support for Flymake
Date: Tue, 07 Dec 2021 02:48:13 +0000

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

Hello,

This patch adds basic Texinfo support for Flymake, following the
annotated example in the Flymake manual.  All it does is feed the
contents of the buffer to the program `makeinfo`, which either reports
errors or outputs the resulting file to the specified /dev/null.

The regexp for identifying errors and warnings is the same as used by
the package Flycheck (see here:
https://github.com/flycheck/flycheck/blob/784f184cdd9f9cb4e3dbb997c09d93e954142842/flycheck.el#L12175).
It seems to identify an optional column number, but I didn't see that in
the programs output or listed in the Man page.  The patch does not make
use of any match for that information.

The Man page says that the program will by default report 100 errors
before stopping.

While the package Flymake is required during compilation, the byte
compiler still wanted the function `flymake--log-1` declared.  This is
the function run by the macro `flymake-log`.

Thank you.

[v2-0001-Add-basic-Texinfo-support-for-Flymake.patch (text/x-patch, attachment)]

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

From: Stefan Kangas <stefan <at> marxist.se>
To: Okamsn <okamsn <at> protonmail.com>
Cc: 52342 <at> debbugs.gnu.org,
 João Távora <joaotavora <at> gmail.com>
Subject: Re: bug#52342: [PATCH] Add Texinfo support for Flymake
Date: Tue, 7 Dec 2021 15:10:42 +0100

Okamsn <okamsn <at> protonmail.com> writes:

> This patch adds basic Texinfo support for Flymake, following the
> annotated example in the Flymake manual.  All it does is feed the
> contents of the buffer to the program `makeinfo`, which either reports
> errors or outputs the resulting file to the specified /dev/null.

João, what do you think of this patch?

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

From: João Távora <joaotavora <at> gmail.com>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: Okamsn <okamsn <at> protonmail.com>, 52342 <at> debbugs.gnu.org
Subject: Re: bug#52342: [PATCH] Add Texinfo support for Flymake
Date: Tue, 7 Dec 2021 14:23:05 +0000

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

Looks 99% fine to me, it's the way Flymake is suppose to be extended
with new backends.  So that part's super.

Not sure about the eval-when-compile for require.  It was my
expression that require is always "when compile".

I've unfortunately been a little away from Emacs lately.

João

On Tue, Dec 7, 2021 at 2:10 PM Stefan Kangas <stefan <at> marxist.se> wrote:

> Okamsn <okamsn <at> protonmail.com> writes:
>
> > This patch adds basic Texinfo support for Flymake, following the
> > annotated example in the Flymake manual.  All it does is feed the
> > contents of the buffer to the program `makeinfo`, which either reports
> > errors or outputs the resulting file to the specified /dev/null.
>
> João, what do you think of this patch?
>


-- 
João Távora

[Message part 2 (text/html, inline)]

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

From: Okamsn <okamsn <at> protonmail.com>
To: João Távora <joaotavora <at> gmail.com>,
 Stefan Kangas <stefan <at> marxist.se>
Cc: 52342 <at> debbugs.gnu.org
Subject: Re: bug#52342: [PATCH] Add Texinfo support for Flymake
Date: Tue, 07 Dec 2021 23:39:31 +0000

On 12/7/21 09:23, João Távora wrote:
> Not sure about the eval-when-compile for require.  It was my
> expression that require is always "when compile".
>
> I've unfortunately been a little away from Emacs lately.
>
> João

My understanding is that `eval-when-compile` is used to make sure that
macro definitions are available during compilation and that the
libraries are not loaded when `texinfo.el` is loaded.  The macros in the
patch are `rx`, `cl-loop`, and `flymake-log`.

There is also the following comment on line 82 of the current version
(https://git.savannah.gnu.org/cgit/emacs.git/tree/lisp/textmodes/texinfo.el#n82):

 > Don't you dare insert any `require' calls at top level in this file
 > --rms.

which I tried to observe.

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

From: João Távora <joaotavora <at> gmail.com>
To: Okamsn <okamsn <at> protonmail.com>, Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: Stefan Kangas <stefan <at> marxist.se>, 52342 <at> debbugs.gnu.org
Subject: Re: bug#52342: [PATCH] Add Texinfo support for Flymake
Date: Tue, 7 Dec 2021 23:43:51 +0000

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

On Tue, Dec 7, 2021 at 11:39 PM Okamsn <okamsn <at> protonmail.com> wrote:

> On 12/7/21 09:23, João Távora wrote:
> > Not sure about the eval-when-compile for require.  It was my
> > expression that require is always "when compile".
> >
> > I've unfortunately been a little away from Emacs lately.
> >
> > João
>
> My understanding is that `eval-when-compile` is used to make sure that
> macro definitions are available during compilation and that the
> libraries are not loaded when `texinfo.el` is loaded.  The macros in the
> patch are `rx`, `cl-loop`, and `flymake-log`.
>

require is always `eval-and-compile` (sorry if I misled you earlier).
It's OK to use `eval-when-compile` when needing `cl-loop` from `cl-lib`
if _all_ you need form `cl-lib` is indeed macros.

But for flymake, you need the actual runtime things too, right? So
I think plain require is better and simpler


> There is also the following comment on line 82 of the current version
> (
> https://git.savannah.gnu.org/cgit/emacs.git/tree/lisp/textmodes/texinfo.el#n82
> ):
>
>  > Don't you dare insert any `require' calls at top level in this file
>  > --rms.
>
> which I tried to observe.


No comment :-)

Anyway, let's hear what byte-compiler guru Stefan Monnier has to say
about this?

João

[Message part 2 (text/html, inline)]

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

From: João Távora <joaotavora <at> gmail.com>
To: Okamsn <okamsn <at> protonmail.com>, Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: Stefan Kangas <stefan <at> marxist.se>, 52342 <at> debbugs.gnu.org
Subject: Re: bug#52342: [PATCH] Add Texinfo support for Flymake
Date: Tue, 7 Dec 2021 23:46:08 +0000

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

On Tue, Dec 7, 2021 at 11:43 PM João Távora <joaotavora <at> gmail.com> wrote:

>
> On Tue, Dec 7, 2021 at 11:39 PM Okamsn <okamsn <at> protonmail.com> wrote:
>
>> On 12/7/21 09:23, João Távora wrote:
>> > Not sure about the eval-when-compile for require.  It was my
>> > expression that require is always "when compile".
>> >
>> > I've unfortunately been a little away from Emacs lately.
>> >
>> > João
>>
>> My understanding is that `eval-when-compile` is used to make sure that
>> macro definitions are available during compilation and that the
>> libraries are not loaded when `texinfo.el` is loaded.  The macros in the
>> patch are `rx`, `cl-loop`, and `flymake-log`.
>>
>
> require is always `eval-and-compile` (sorry if I misled you earlier).
> It's OK to use `eval-when-compile` when needing `cl-loop` from `cl-lib`
> if _all_ you need form `cl-lib` is indeed macros.
>
> But for flymake, you need the actual runtime things too, right? So
> I think plain require is better and simpler
>

Hmmm, on second thought, it you're planning on relying on
autoloads for ultimate loading lazyness.... Hmm, maybe
you're right...

João

[Message part 2 (text/html, inline)]

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

From: Stefan Kangas <stefan <at> marxist.se>
To: João Távora <joaotavora <at> gmail.com>, 
 Okamsn <okamsn <at> protonmail.com>, Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 52342 <at> debbugs.gnu.org
Subject: Re: bug#52342: [PATCH] Add Texinfo support for Flymake
Date: Wed, 8 Dec 2021 01:50:42 +0100

João Távora <joaotavora <at> gmail.com> writes:

>>  > Don't you dare insert any `require' calls at top level in this file
>>  > --rms.
>>
>> which I tried to observe.
>
> No comment :-)

That file is really jumping through a lot of hoops to avoid require, for
some reason.  It seems like yet another thing that was probably relevant
30 years ago, but not so much today.  Personally, I'd just simplify it.

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

From: Okamsn <okamsn <at> protonmail.com>
To: João Távora <joaotavora <at> gmail.com>,
 Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: Stefan Kangas <stefan <at> marxist.se>, 52342 <at> debbugs.gnu.org
Subject: Re: bug#52342: [PATCH] Add Texinfo support for Flymake
Date: Wed, 08 Dec 2021 01:00:54 +0000

On 12/7/21 18:46, João Távora wrote:
>     require is always `eval-and-compile` (sorry if I misled you earlier).
>     It's OK to use `eval-when-compile` when needing `cl-loop` from `cl-lib`
>     if _all_ you need form `cl-lib` is indeed macros.
>
>     But for flymake, you need the actual runtime things too, right? So
>     I think plain require is better and simpler
>
>
> Hmmm, on second thought, it you're planning on relying on
> autoloads for ultimate loading lazyness.... Hmm, maybe
> you're right...
>
> João

My thinking was that the Flymake features would be loaded when
`flymake-mode` was enabled and that the added function `texinfo-flymake`
won't run until Flymake is loaded and processes
`flymake-diagnostic-functions`. Does that sound right?

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

From: Okamsn <okamsn <at> protonmail.com>
To: João Távora <joaotavora <at> gmail.com>,
 Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: Stefan Kangas <stefan <at> marxist.se>, 52342 <at> debbugs.gnu.org
Subject: Re: bug#52342: [PATCH] Add Texinfo support for Flymake
Date: Wed, 08 Dec 2021 01:03:15 +0000

On 12/7/21 20:00, Okamsn wrote:
> On 12/7/21 18:46, João Távora wrote:
>>      require is always `eval-and-compile` (sorry if I misled you earlier).
>>      It's OK to use `eval-when-compile` when needing `cl-loop` from `cl-lib`
>>      if _all_ you need form `cl-lib` is indeed macros.
>>
>>      But for flymake, you need the actual runtime things too, right? So
>>      I think plain require is better and simpler
>>
>>
>> Hmmm, on second thought, it you're planning on relying on
>> autoloads for ultimate loading lazyness.... Hmm, maybe
>> you're right...
>>
>> João
>
> My thinking was that the Flymake features would be loaded when
> `flymake-mode` was enabled and that the added function `texinfo-flymake`
> won't run until Flymake is loaded and processes
> `flymake-diagnostic-functions`. Does that sound right?

This is what happened when I tested it with `emacs -q`, I should add.

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

From: Okamsn <okamsn <at> protonmail.com>
To: Stefan Kangas <stefan <at> marxist.se>,
 João Távora <joaotavora <at> gmail.com>,
 Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 52342 <at> debbugs.gnu.org
Subject: Re: bug#52342: [PATCH] Add Texinfo support for Flymake
Date: Fri, 10 Dec 2021 01:40:01 +0000

On 12/7/21 19:50, Stefan Kangas wrote:
> João Távora <joaotavora <at> gmail.com> writes:
>
>>>   > Don't you dare insert any `require' calls at top level in this file
>>>   > --rms.
>>>
>>> which I tried to observe.
>>
>> No comment :-)
>
> That file is really jumping through a lot of hoops to avoid require, for
> some reason.  It seems like yet another thing that was probably relevant
> 30 years ago, but not so much today.  Personally, I'd just simplify it.
>

Hello,

Would the file `texinfo.el` loading Flymake affect the use of a more
recent version of Flymake installed as a package? I have run into issues
when using Org as a downloaded package, where a library causes the
built-in version to load, which breaks using the newer features.

The file `python.el` doesn't seem to do any loading/declaring of Flymake
features.

Thank you.

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

From: Stefan Kangas <stefan <at> marxist.se>
To: Okamsn <okamsn <at> protonmail.com>,
 João Távora <joaotavora <at> gmail.com>, 
 Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 52342 <at> debbugs.gnu.org
Subject: Re: bug#52342: [PATCH] Add Texinfo support for Flymake
Date: Thu, 9 Dec 2021 18:07:31 -0800

Okamsn <okamsn <at> protonmail.com> writes:

> Would the file `texinfo.el` loading Flymake affect the use of a more
> recent version of Flymake installed as a package? I have run into issues
> when using Org as a downloaded package, where a library causes the
> built-in version to load, which breaks using the newer features.

AFAIK, this should just work: if a newer version of a package is
installed it should be used instead of the built-in one.  If there are
any problems with that, it might be indicative of a bug somewhere.

> The file `python.el` doesn't seem to do any loading/declaring of Flymake
> features.

Probably it relies on autoloads in flymake itself.  Maybe we could do
the same here, but it depends on whether or not it would make sense to
autoload the things you need.  João is probably the best person to
answer that.

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

From: Okamsn <okamsn <at> protonmail.com>
To: João Távora <joaotavora <at> gmail.com>,
 Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: Stefan Kangas <stefan <at> marxist.se>, 52342 <at> debbugs.gnu.org
Subject: Re: bug#52342: [PATCH] Add Texinfo support for Flymake
Date: Sun, 19 Dec 2021 16:17:56 +0000

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

On 12/7/21 18:46, João Távora wrote:
> On Tue, Dec 7, 2021 at 11:43 PM João Távora <joaotavora <at> gmail.com
> <mailto:joaotavora <at> gmail.com>> wrote:
>
>
>     On Tue, Dec 7, 2021 at 11:39 PM Okamsn <okamsn <at> protonmail.com
>     <mailto:okamsn <at> protonmail.com>> wrote:
>
>         On 12/7/21 09:23, João Távora wrote:
>          > Not sure about the eval-when-compile for require.  It was my
>          > expression that require is always "when compile".
>          >
>          > I've unfortunately been a little away from Emacs lately.
>          >
>          > João
>
>         My understanding is that `eval-when-compile` is used to make
>         sure that
>         macro definitions are available during compilation and that the
>         libraries are not loaded when `texinfo.el` is loaded.  The
>         macros in the
>         patch are `rx`, `cl-loop`, and `flymake-log`.
>
>
>     require is always `eval-and-compile` (sorry if I misled you earlier).
>     It's OK to use `eval-when-compile` when needing `cl-loop` from `cl-lib`
>     if _all_ you need form `cl-lib` is indeed macros.
>
>     But for flymake, you need the actual runtime things too, right? So
>     I think plain require is better and simpler
>
>
> Hmmm, on second thought, it you're planning on relying on
> autoloads for ultimate loading lazyness.... Hmm, maybe
> you're right...
>
> João

Hello Stefan Monnier,

Do you have any thoughts about the lazy loading of Flymake features used
in the patch discussed in this thread (re-attached for convenience)?

Thank you.

[v2-0001-Add-basic-Texinfo-support-for-Flymake.patch (text/x-patch, attachment)]

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

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: Okamsn <okamsn <at> protonmail.com>
Cc: Stefan Kangas <stefan <at> marxist.se>,
 João Távora <joaotavora <at> gmail.com>,
 52342 <at> debbugs.gnu.org
Subject: Re: bug#52342: [PATCH] Add Texinfo support for Flymake
Date: Tue, 04 Jan 2022 15:21:02 -0500

Sorry for this late answer, you got stuck in a slow lane :-(

> Do you have any thoughts about the lazy loading of Flymake features used
> in the patch discussed in this thread (re-attached for convenience)?

Looks fine to me.
[ The amount of work needed for `flymake-log` is a bit disheartening, tho.
  Not sure making it a macro is worth the trouble.  ]


        Stefan

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

From: João Távora <joaotavora <at> gmail.com>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: Okamsn <okamsn <at> protonmail.com>, Stefan Kangas <stefan <at> marxist.se>,
 52342 <at> debbugs.gnu.org
Subject: Re: bug#52342: [PATCH] Add Texinfo support for Flymake
Date: Tue, 4 Jan 2022 21:00:04 +0000

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

On Tue, Jan 4, 2022 at 8:21 PM Stefan Monnier <monnier <at> iro.umontreal.ca>
wrote:

> Sorry for this late answer, you got stuck in a slow lane :-(
>
> > Do you have any thoughts about the lazy loading of Flymake features used
> > in the patch discussed in this thread (re-attached for convenience)?
>
> Looks fine to me.
> [ The amount of work needed for `flymake-log` is a bit disheartening, tho.
>   Not sure making it a macro is worth the trouble.  ]


Yup, I wrote somewhere else that I think that part is a bit
over-enginneered.
The idea was/is to have it add the locus of the log call to the log entry.
But I don't remember ever having used that functionality.

So go ahead and make it an (autoloaded) function if you think it's best.

João

[Message part 2 (text/html, inline)]

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

From: Okamsn <okamsn <at> protonmail.com>
To: João Távora <joaotavora <at> gmail.com>,
 Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: Stefan Kangas <stefan <at> marxist.se>, 52342 <at> debbugs.gnu.org
Subject: Re: bug#52342: [PATCH] Add Texinfo support for Flymake
Date: Fri, 15 Apr 2022 01:12:21 +0000

On 1/4/22 16:00, João Távora wrote:
> On Tue, Jan 4, 2022 at 8:21 PM Stefan Monnier <monnier <at> iro.umontreal.ca
> <mailto:monnier <at> iro.umontreal.ca>> wrote:
>
>     Sorry for this late answer, you got stuck in a slow lane :-(
>
>      > Do you have any thoughts about the lazy loading of Flymake
>     features used
>      > in the patch discussed in this thread (re-attached for convenience)?
>
>     Looks fine to me.
>     [ The amount of work needed for `flymake-log` is a bit
>     disheartening, tho.
>        Not sure making it a macro is worth the trouble.  ]
>
>
> Yup, I wrote somewhere else that I think that part is a bit
> over-enginneered.
> The idea was/is to have it add the locus of the log call to the log entry.
> But I don't remember ever having used that functionality.
>
> So go ahead and make it an (autoloaded) function if you think it's best.
>
> João

Hello,

Are you still willing to add this Flymake checker for Texinfo?

Thank you.

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

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: Okamsn <okamsn <at> protonmail.com>
Cc: Stefan Kangas <stefan <at> marxist.se>,
 João Távora <joaotavora <at> gmail.com>,
 52342 <at> debbugs.gnu.org
Subject: Re: bug#52342: [PATCH] Add Texinfo support for Flymake
Date: Sat, 16 Apr 2022 17:59:23 -0400

Hi Okamsn, (?)

Okamsn [2021-12-19 16:17:56] wrote:
> Do you have any thoughts about the lazy loading of Flymake features used
> in the patch discussed in this thread (re-attached for convenience)?

Okamsn [2022-04-15 01:12:21] wrote:
> Are you still willing to add this Flymake checker for Texinfo?

Sorry for dropping the ball: Yes!
I just pushed your patch to Emacs's `master` branch.
Thank you for your contribution,


        Stefan

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: Okamsn <okamsn <at> protonmail.com>, Stefan Kangas <stefan <at> marxist.se>,
 João Távora <joaotavora <at> gmail.com>, 52342 <at> debbugs.gnu.org
Subject: Re: bug#52342: [PATCH] Add Texinfo support for Flymake
Date: Thu, 08 Sep 2022 16:25:00 +0200

Stefan Monnier <monnier <at> iro.umontreal.ca> writes:

> I just pushed your patch to Emacs's `master` branch.

(The bug report was left open, so I'm closing it now.)

Previous Next

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