GNU bug report logs - #72761
issues with Flymake online documentation

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 72761 in the body.
You can then email your comments to 72761 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: Lester Longley <lester <at> ieee.org>
To: bug-gnu-emacs <at> gnu.org
Subject: issues with Flymake online documentation
Date: Thu, 22 Aug 2024 12:43:23 -0400

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

Hello,

I see two issues at manual page:
https://www.gnu.org/software/emacs/manual/html_mono/flymake.html

(1) in sentence "See Eglot Features
<https://www.gnu.org/software/emacs/manual/html_mono/eglot.html#Eglot-Features>
 in Eglot: The Emacs LSP Client Flymake is also designed to be easily
extended to support new backends via an Elisp interface.",
the embedded link
https://www.gnu.org/software/emacs/manual/html_node/eglot_html/Eglot-Features.html#Eglot-Features
doesn't work (404 error)
I think the correct link should be:
https://www.gnu.org/software/emacs/manual/html_node/eglot/Eglot-Features.html#Eglot-Features

The same issue is present at the "html_node" page
https://www.gnu.org/software/emacs/manual/html_node/flymake/index.html

(2) the section
https://www.gnu.org/software/emacs/manual/html_mono/flymake.html#Mode-line-status
is empty, when I view it in Chrome 127, on a Chromebook, or in Chrome, on
an Android phone.
Here's browser snapshot from Chromebook; Android phone gives similar view:

[image: image.png]

The "empty" section is a table:

    @multitable @columnfractions 0.25 0.75
    ...
    @end multitable

This results in what appears (to me) to be normal HTML for a table
(excerpted from Chrome's view-source)

    <p>The following statuses are defined:
    </p>
    <table>
    <tr><td width="25%">[<var>nerrors</var> <var>nwarnings</var>
...]</td><td width="75%">Normal operation. <var>nerrors</var> and
<var>nwarnings</var> are, respectively,
    the total number of errors and warnings found during the last buffer
    check, for all backends. They may be followed by other totals for
    other types of diagnostics (see <a
href="#Flymake-error-types">Customizing Flymake error types</a>).</td></tr>
    <tr><td width="25%"><code>Wait</code></td><td width="75%">Some Flymake
backends haven&rsquo;t reported since the last time they
    where questioned.  It is reasonable to assume that this is a temporary
    delay and Flymake will resume normal operation soon.</td></tr>
    <tr><td width="25%"><code>!</code></td><td width="75%">All the
configured Flymake backends have disabled themselves: Flymake
    cannot annotate the buffer and action from the user is needed to
    investigate and remedy the situation (see <a
href="#Troubleshooting">Troubleshooting</a>).</td></tr>
    <tr><td width="25%"><code>?</code></td><td width="75%">There are no
applicable Flymake backends for this buffer, thus Flymake
    cannot annotate it.  To fix this, a user may look to extending Flymake
    and add a new backend (see <a href="#Extending-Flymake">Extending
Flymake</a>).</td></tr>
    </table>

Just in case, I tried toggling light/dark theme but didn't see the expected
table appear.

A clue, perhaps, from Chrome DevTools is that Chrome seems to parse *two*
tables here:

[image: image.png]

Yet this same table looks fine here:
https://www.gnu.org/software/emacs/manual/html_node/flymake/Mode-line-status.html

Also, for reference, in "eww", this section shows the expected table:

[image: image.png]

I don't see any recent changes in
https://git.savannah.gnu.org/cgit/emacs.git/tree/doc/misc/flymake.texi?h=emacs-30
which
might pertain to these issues.

Regards,
Lester

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

[image.png (image/png, inline)]

[image.png (image/png, inline)]

[image.png (image/png, inline)]

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Lester Longley <lester <at> ieee.org>
Cc: 72761 <at> debbugs.gnu.org
Subject: Re: bug#72761: issues with Flymake online documentation
Date: Thu, 22 Aug 2024 21:03:01 +0300

> Date: Thu, 22 Aug 2024 12:43:23 -0400
> From:  Lester Longley via "Bug reports for GNU Emacs,
>  the Swiss army knife of text editors" <bug-gnu-emacs <at> gnu.org>
> 
> I see two issues at manual page: https://www.gnu.org/software/emacs/manual/html_mono/flymake.html
> 
> (1) in sentence "See Eglot Features in Eglot: The Emacs LSP Client Flymake is also designed to be easily
> extended to support new backends via an Elisp interface.",
> the embedded link
> https://www.gnu.org/software/emacs/manual/html_node/eglot_html/Eglot-Features.html#Eglot-Features
> doesn't work (404 error)
> I think the correct link should be:
> https://www.gnu.org/software/emacs/manual/html_node/eglot/Eglot-Features.html#Eglot-Features
> 
> The same issue is present at the "html_node" page
> https://www.gnu.org/software/emacs/manual/html_node/flymake/index.html

I don't see this here.  First, the links are to
https://www.gnu.org/software/emacs/manual/html_mono/eglot.html#Eglot-Features
and not as you say, and they both work here.

> (2) the section https://www.gnu.org/software/emacs/manual/html_mono/flymake.html#Mode-line-status is
> empty, when I view it in Chrome 127, on a Chromebook, or in Chrome, on an Android phone.
> Here's browser snapshot from Chromebook; Android phone gives similar view:

I do see this.  It's probably some problem with the produced HTML,
because the HTML is not empty:

  <p>The following statuses are defined:
  </p>
  <table>
  <tr><td width="25%">[<var>nerrors</var> <var>nwarnings</var> ...]</td><td width="75%">Normal operation. <var>nerrors</var> and <var>nwarnings</var> are, respectively,
  the total number of errors and warnings found during the last buffer
  check, for all backends. They may be followed by other totals for
  other types of diagnostics (see <a href="#Flymake-error-types">Customizing Flymake error types</a>).</td></tr>
  <tr><td width="25%"><code>Wait</code></td><td width="75%">Some Flymake backends haven&rsquo;t reported since the last time they
  where questioned.  It is reasonable to assume that this is a temporary
  delay and Flymake will resume normal operation soon.</td></tr>
  <tr><td width="25%"><code>!</code></td><td width="75%">All the configured Flymake backends have disabled themselves: Flymake
  cannot annotate the buffer and action from the user is needed to
  investigate and remedy the situation (see <a href="#Troubleshooting">Troubleshooting</a>).</td></tr>
  <tr><td width="25%"><code>?</code></td><td width="75%">There are no applicable Flymake backends for this buffer, thus Flymake
  cannot annotate it.  To fix this, a user may look to extending Flymake
  and add a new backend (see <a href="#Extending-Flymake">Extending Flymake</a>).</td></tr>
  </table>

Maybe some HTML expert can tell what is wrong with this <table>?

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

From: Lester Longley <lester <at> ieee.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 72761 <at> debbugs.gnu.org
Subject: Re: bug#72761: issues with Flymake online documentation
Date: Thu, 22 Aug 2024 14:21:25 -0400

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

Hi Eli,

Thanks for taking a look at these items.

Re: the first issue, on further experimentation,
it actually seems to manifest itself (as
https://www.gnu.org/software/emacs/manual/html_node/eglot_html/Eglot-Features.html#Eglot-Features
)
only if I go to this URL (w/o the trailing "index.html"):
https://www.gnu.org/software/emacs/manual/html_node/flymake/
... which must be the way I originally stumbled on this.

Regards,
Lester


On Thu, Aug 22, 2024 at 2:03 PM Eli Zaretskii <eliz <at> gnu.org> wrote:

> > Date: Thu, 22 Aug 2024 12:43:23 -0400
> > From:  Lester Longley via "Bug reports for GNU Emacs,
> >  the Swiss army knife of text editors" <bug-gnu-emacs <at> gnu.org>
> >
> > I see two issues at manual page:
> https://www.gnu.org/software/emacs/manual/html_mono/flymake.html
> >
> > (1) in sentence "See Eglot Features in Eglot: The Emacs LSP Client
> Flymake is also designed to be easily
> > extended to support new backends via an Elisp interface.",
> > the embedded link
> >
> https://www.gnu.org/software/emacs/manual/html_node/eglot_html/Eglot-Features.html#Eglot-Features
> > doesn't work (404 error)
> > I think the correct link should be:
> >
> https://www.gnu.org/software/emacs/manual/html_node/eglot/Eglot-Features.html#Eglot-Features
> >
> > The same issue is present at the "html_node" page
> > https://www.gnu.org/software/emacs/manual/html_node/flymake/index.html
>
> I don't see this here.  First, the links are to
>
> https://www.gnu.org/software/emacs/manual/html_mono/eglot.html#Eglot-Features
> and not as you say, and they both work here.
>
> > (2) the section
> https://www.gnu.org/software/emacs/manual/html_mono/flymake.html#Mode-line-status
> is
> > empty, when I view it in Chrome 127, on a Chromebook, or in Chrome, on
> an Android phone.
> > Here's browser snapshot from Chromebook; Android phone gives similar
> view:
>
> I do see this.  It's probably some problem with the produced HTML,
> because the HTML is not empty:
>
>   <p>The following statuses are defined:
>   </p>
>   <table>
>   <tr><td width="25%">[<var>nerrors</var> <var>nwarnings</var>
> ...]</td><td width="75%">Normal operation. <var>nerrors</var> and
> <var>nwarnings</var> are, respectively,
>   the total number of errors and warnings found during the last buffer
>   check, for all backends. They may be followed by other totals for
>   other types of diagnostics (see <a
> href="#Flymake-error-types">Customizing Flymake error types</a>).</td></tr>
>   <tr><td width="25%"><code>Wait</code></td><td width="75%">Some Flymake
> backends haven&rsquo;t reported since the last time they
>   where questioned.  It is reasonable to assume that this is a temporary
>   delay and Flymake will resume normal operation soon.</td></tr>
>   <tr><td width="25%"><code>!</code></td><td width="75%">All the
> configured Flymake backends have disabled themselves: Flymake
>   cannot annotate the buffer and action from the user is needed to
>   investigate and remedy the situation (see <a
> href="#Troubleshooting">Troubleshooting</a>).</td></tr>
>   <tr><td width="25%"><code>?</code></td><td width="75%">There are no
> applicable Flymake backends for this buffer, thus Flymake
>   cannot annotate it.  To fix this, a user may look to extending Flymake
>   and add a new backend (see <a href="#Extending-Flymake">Extending
> Flymake</a>).</td></tr>
>   </table>
>
> Maybe some HTML expert can tell what is wrong with this <table>?
>

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

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Lester Longley <lester <at> ieee.org>
Cc: 72761 <at> debbugs.gnu.org
Subject: Re: bug#72761: issues with Flymake online documentation
Date: Thu, 22 Aug 2024 21:23:57 +0300

> From: Lester Longley <lester <at> ieee.org>
> Date: Thu, 22 Aug 2024 14:21:25 -0400
> Cc: 72761 <at> debbugs.gnu.org
> 
> Thanks for taking a look at these items.
> 
> Re: the first issue, on further experimentation,
> it actually seems to manifest itself (as
> https://www.gnu.org/software/emacs/manual/html_node/eglot_html/Eglot-Features.html#Eglot-Features)
> only if I go to this URL (w/o the trailing "index.html"):
> https://www.gnu.org/software/emacs/manual/html_node/flymake/
> ... which must be the way I originally stumbled on this.

Then I guess someone who knows more than I do about HTML will need to
explain what happens there...

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

From: Lester Longley <lester <at> ieee.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 72761 <at> debbugs.gnu.org
Subject: Re: bug#72761: issues with Flymake online documentation
Date: Thu, 22 Aug 2024 15:07:57 -0400

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

OK, here's a clue re: the first issue.

The flymake "nodes" (
https://www.gnu.org/software/emacs/manual/html_node/flymake/ ) manual
(attempts) to make a relative "cross link" to the eglot "nodes" manual,
like so:

    <a data-manual="eglot"
href="../eglot_html/Eglot-Features.html#Eglot-Features">Eglot Features</a>

That "relative cross link" must not work, apparently, within the server
tree at /software/emacs/manual/

This happens regardless of
https://www.gnu.org/software/emacs/manual/html_node/flymake/ vs.
https://www.gnu.org/software/emacs/manual/html_node/flymake/index.html
(I was hasty+wrong in claiming that that distinction was pertinent.)

OTOH, FWIW, the *mono* manual
https://www.gnu.org/software/emacs/manual/html_mono/flymake.html links like
this

    <a data-manual="eglot" href="eglot.html#Eglot-Features">Eglot
Features</a>

... which works.


On Thu, Aug 22, 2024 at 2:24 PM Eli Zaretskii <eliz <at> gnu.org> wrote:

> > From: Lester Longley <lester <at> ieee.org>
> > Date: Thu, 22 Aug 2024 14:21:25 -0400
> > Cc: 72761 <at> debbugs.gnu.org
> >
> > Thanks for taking a look at these items.
> >
> > Re: the first issue, on further experimentation,
> > it actually seems to manifest itself (as
> >
> https://www.gnu.org/software/emacs/manual/html_node/eglot_html/Eglot-Features.html#Eglot-Features
> )
> > only if I go to this URL (w/o the trailing "index.html"):
> > https://www.gnu.org/software/emacs/manual/html_node/flymake/
> > ... which must be the way I originally stumbled on this.
>
> Then I guess someone who knows more than I do about HTML will need to
> explain what happens there...
>

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

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Lester Longley <lester <at> ieee.org>
Cc: 72761 <at> debbugs.gnu.org
Subject: Re: bug#72761: issues with Flymake online documentation
Date: Thu, 22 Aug 2024 22:15:47 +0300

> From: Lester Longley <lester <at> ieee.org>
> Date: Thu, 22 Aug 2024 15:07:57 -0400
> Cc: 72761 <at> debbugs.gnu.org
> 
> OK, here's a clue re: the first issue.
> 
> The flymake "nodes" ( https://www.gnu.org/software/emacs/manual/html_node/flymake/ ) manual (attempts) to
> make a relative "cross link" to the eglot "nodes" manual, like so:
> 
>     <a data-manual="eglot" href="../eglot_html/Eglot-Features.html#Eglot-Features">Eglot Features</a>

Yes, that part was evident.  The question was why it says
"eglot_html".  And I just found the answer: it's a relatively recent
change in Texinfo.  From the Texinfo NEWS file:

  7.0 (7 November 2022)
  * texi2any
  [...]
   . HTML output:
       . use manual_name_html as output directory for split HTML instead of
	 manual_name or manual_name.html

Ugh!

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

From: Lester Longley <lester <at> ieee.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 72761 <at> debbugs.gnu.org
Subject: Re: bug#72761: issues with Flymake online documentation
Date: Thu, 22 Aug 2024 17:01:37 -0400

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

Hi Eli,

Thanks for looking at that further.

Re: the second issue, the problem seems to start here, with this: <table
style="float:left" width="100%"> element (see PROBLEM below), which
(a) seems out of place
(b) is never closed w/ "</table>, as best I can see (as per inspection of
saved output from curl "
https://www.gnu.org/software/emacs/manual/html_mono/flymake.html")
Instead, this "<table>" seems to be closed with a mismatched "</ul>"

          <p>Syntax checks happen &ldquo;on-the-fly&rdquo;.  Each check is
started whenever:
          </p>

          <table style="float:left" width="100%">  <== PROBLEM?
            <li> <code>flymake-mode</code> is started, unless
              <code>flymake-start-on-flymake-mode</code> is
<code>nil</code>;

            </li><li> the buffer is saved, unless
<code>flymake-start-on-save-buffer</code> is
                   <code>nil</code>;

                 </li><li> some changes were made to the buffer more than
<code>0.5</code> seconds ago

               (the delay is configurable in
<code>flymake-no-changes-timeout</code>).

                      </li><li> When the user invokes the command
<code>flymake-start</code>.
                           </li></ul>  <== PROBLEM?

            <p>If the check detected errors or warnings, the respective
buffer
               regions are highlighted.  See <a
href="#Finding-diagnostics">Finding diagnostics</a>, for how to

                       learn what the problems are.
            </p>

I am unfamiliar w/ Texinfo, but I nonetheless don't see any "obvious"
reason that a <table> element should be emitted at the above location,
based on the below excerpt from
https://git.savannah.gnu.org/cgit/emacs.git/tree/doc/misc/flymake.texi?h=emacs-29#n115
(I'm just guessing on the corresponding version of this file currently used
for the online documentation)

    Syntax checks happen ``on-the-fly''.  Each check is started whenever:

    @itemize @bullet
    @item
    @code{flymake-mode} is started, unless
    @code{flymake-start-on-flymake-mode} is @code{nil};

    @item
    the buffer is saved, unless @code{flymake-start-on-save-buffer} is
    @code{nil};

    @item
    some changes were made to the buffer more than @code{0.5} seconds ago
    (the delay is configurable in @code{flymake-no-changes-timeout}).

    @item
    When the user invokes the command @code{flymake-start}.
    @end itemize

Perhaps this is helpful; if not please pardon & ignore.

On Thu, Aug 22, 2024 at 3:16 PM Eli Zaretskii <eliz <at> gnu.org> wrote:

> > From: Lester Longley <lester <at> ieee.org>
> > Date: Thu, 22 Aug 2024 15:07:57 -0400
> > Cc: 72761 <at> debbugs.gnu.org
> >
> > OK, here's a clue re: the first issue.
> >
> > The flymake "nodes" (
> https://www.gnu.org/software/emacs/manual/html_node/flymake/ ) manual
> (attempts) to
> > make a relative "cross link" to the eglot "nodes" manual, like so:
> >
> >     <a data-manual="eglot"
> href="../eglot_html/Eglot-Features.html#Eglot-Features">Eglot Features</a>
>
> Yes, that part was evident.  The question was why it says
> "eglot_html".  And I just found the answer: it's a relatively recent
> change in Texinfo.  From the Texinfo NEWS file:
>
>   7.0 (7 November 2022)
>   * texi2any
>   [...]
>    . HTML output:
>        . use manual_name_html as output directory for split HTML instead of
>          manual_name or manual_name.html
>
> Ugh!
>

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

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Lester Longley <lester <at> ieee.org>
Cc: 72761 <at> debbugs.gnu.org
Subject: Re: bug#72761: issues with Flymake online documentation
Date: Fri, 23 Aug 2024 10:06:41 +0300

> From: Lester Longley <lester <at> ieee.org>
> Date: Thu, 22 Aug 2024 17:01:37 -0400
> Cc: 72761 <at> debbugs.gnu.org
> 
> Re: the second issue, the problem seems to start here, with this: <table style="float:left" width="100%">
> element (see PROBLEM below), which
> (a) seems out of place
> (b) is never closed w/ "</table>, as best I can see (as per inspection of saved output from curl
> "https://www.gnu.org/software/emacs/manual/html_mono/flymake.html")
> Instead, this "<table>" seems to be closed with a mismatched "</ul>"

No, there _is_ a </table>, see below, where I copied the "page source"
from my browser.

> I am unfamiliar w/ Texinfo, but I nonetheless don't see any "obvious" reason that a <table> element should be
> emitted at the above location, based on the below excerpt from
> https://git.savannah.gnu.org/cgit/emacs.git/tree/doc/misc/flymake.texi?h=emacs-29#n115 (I'm just guessing on
> the corresponding version of this file currently used for the online documentation)

No, that table is the translation of @multitable.

  <p>The following statuses are defined:
  </p>
  <table>
  <tr><td width="25%">[<var>nerrors</var> <var>nwarnings</var> ...]</td><td width="75%">Normal operation. <var>nerrors</var> and <var>nwarnings</var> are, respectively,
  the total number of errors and warnings found during the last buffer
  check, for all backends. They may be followed by other totals for
  other types of diagnostics (see <a href="#Flymake-error-types">Customizing Flymake error types</a>).</td></tr>
  <tr><td width="25%"><code>Wait</code></td><td width="75%">Some Flymake backends haven&rsquo;t reported since the last time they
  where questioned.  It is reasonable to assume that this is a temporary
  delay and Flymake will resume normal operation soon.</td></tr>
  <tr><td width="25%"><code>!</code></td><td width="75%">All the configured Flymake backends have disabled themselves: Flymake
  cannot annotate the buffer and action from the user is needed to
  investigate and remedy the situation (see <a href="#Troubleshooting">Troubleshooting</a>).</td></tr>
  <tr><td width="25%"><code>?</code></td><td width="75%">There are no applicable Flymake backends for this buffer, thus Flymake
  cannot annotate it.  To fix this, a user may look to extending Flymake
  and add a new backend (see <a href="#Extending-Flymake">Extending Flymake</a>).</td></tr>
  </table>

I guess I will ask the Texinfo developers to take a look.

Thanks.

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

From: Lester Longley <lester <at> ieee.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 72761 <at> debbugs.gnu.org
Subject: Re: bug#72761: issues with Flymake online documentation
Date: Fri, 23 Aug 2024 03:40:13 -0400

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

Good morning.

The following difference seems like it could be relevant.

As an aside, I have found it more informative to download the .html files
and manually inspect them, rather than to look at Chrome's Elements tree,
since that itself seems to get confused by what appears to me to be a list
started w/ <table> but ended w/ </ul>.

In summary, I think that the translation of the @multitable is itself fine,
but that the prior presence of @itemize @bullet ... , with its mismatch
<table> ... </ul>, confuses Chrome. and causes it to (not) render the table
(from @multitable) properly.

----------------------------------------------------------------------------------------

(a) in the (shorter)
https://www.gnu.org/software/emacs/manual/html_node/flymake/Starting-Flymake.html
:
<ul> starts, and </ul> closes, the list, and this documentation "node"
renders fine.

      <p>Syntax checks happen &ldquo;on-the-fly&rdquo;.  Each check is
started whenever:
      </p>

OK:   <ul class="itemize mark-bullet">
        <li><code class="code">flymake-mode</code> is started, unless
          <code class="code">flymake-start-on-flymake-mode</code> is <code
class="code">nil</code>;

        </li><li>the buffer is saved, unless <code
class="code">flymake-start-on-save-buffer</code> is
               <code class="code">nil</code>;

             </li><li>some changes were made to the buffer more than <code
class="code">0.5</code> seconds ago

                       (the delay is configurable in <code
class="code">flymake-no-changes-timeout</code>).

                  </li><li>When the user invokes the command <code
class="code">flymake-start</code>.
OK:                    </li></ul>

----------------------------------------------------------------------------------------

(b) however, in the (longer & problematic) (mono)
https://www.gnu.org/software/emacs/manual/html_mono/flymake.html

          <p>Syntax checks happen &ldquo;on-the-fly&rdquo;.  Each check is
started whenever:
          </p>
BAD:       <table style="float:left" width="100%">
            <li> <code>flymake-mode</code> is started, unless
              <code>flymake-start-on-flymake-mode</code> is
<code>nil</code>;

            </li><li> the buffer is saved, unless
<code>flymake-start-on-save-buffer</code> is
                   <code>nil</code>;

                 </li><li> some changes were made to the buffer more than
<code>0.5</code> seconds ago

               (the delay is configurable in
<code>flymake-no-changes-timeout</code>).

                      </li><li> When the user invokes the command
<code>flymake-start</code>.
 OK:                       </li></ul>
----------------------------------------------------------------------------------------

I *guess* that this latter "unclosed" <table> is what causes trouble
further down in this file, even though (a new,  matching) <table> &
</table> match up there.
(I haven't yet figured out how to rebuild the manuals to do more direct
experiments/isolation.)
----------------------------------------------------------------------------------------

          <p>The following statuses are defined:
          </p>
OK:          <table>
            <tr><td width="25%">[<var>nerrors</var> <var>nwarnings</var>
...]</td><td width="75%">Normal operation. <var>nerrors</var> and
<var>nwarnings</var> are, respectively,


        the total number of errors and warnings found during the last buffer


        check, for all backends. They may be followed by other totals for


        other types of diagnostics (see <a
href="#Flymake-error-types">Customizing Flymake error types</a>).</td></tr>
            <tr><td width="25%"><code>Wait</code></td><td width="75%">Some
Flymake backends haven&rsquo;t reported since the last time they

                            where questioned.  It is reasonable to assume
that this is a temporary

                            delay and Flymake will resume normal operation
soon.</td></tr>
            <tr><td width="25%"><code>!</code></td><td width="75%">All the
configured Flymake backends have disabled themselves: Flymake
                                                                   cannot
annotate the buffer and action from the user is needed to

 investigate and remedy the situation (see <a
href="#Troubleshooting">Troubleshooting</a>).</td></tr>
            <tr><td width="25%"><code>?</code></td><td width="75%">There
are no applicable Flymake backends for this buffer, thus Flymake
                                                                   cannot
annotate it.  To fix this, a user may look to extending Flymake
                                                                   and add
a new backend (see <a href="#Extending-Flymake">Extending
Flymake</a>).</td></tr>
 OK:         </table>

----------------------------------------------------------------------------------------

-Lester

On Fri, Aug 23, 2024 at 3:06 AM Eli Zaretskii <eliz <at> gnu.org> wrote:

> > From: Lester Longley <lester <at> ieee.org>
> > Date: Thu, 22 Aug 2024 17:01:37 -0400
> > Cc: 72761 <at> debbugs.gnu.org
> >
> > Re: the second issue, the problem seems to start here, with this: <table
> style="float:left" width="100%">
> > element (see PROBLEM below), which
> > (a) seems out of place
> > (b) is never closed w/ "</table>, as best I can see (as per inspection
> of saved output from curl
> > "https://www.gnu.org/software/emacs/manual/html_mono/flymake.html")
> > Instead, this "<table>" seems to be closed with a mismatched "</ul>"
>
> No, there _is_ a </table>, see below, where I copied the "page source"
> from my browser.
>
> > I am unfamiliar w/ Texinfo, but I nonetheless don't see any "obvious"
> reason that a <table> element should be
> > emitted at the above location, based on the below excerpt from
> >
> https://git.savannah.gnu.org/cgit/emacs.git/tree/doc/misc/flymake.texi?h=emacs-29#n115
> (I'm just guessing on
> > the corresponding version of this file currently used for the online
> documentation)
>
> No, that table is the translation of @multitable.
>
>   <p>The following statuses are defined:
>   </p>
>   <table>
>   <tr><td width="25%">[<var>nerrors</var> <var>nwarnings</var>
> ...]</td><td width="75%">Normal operation. <var>nerrors</var> and
> <var>nwarnings</var> are, respectively,
>   the total number of errors and warnings found during the last buffer
>   check, for all backends. They may be followed by other totals for
>   other types of diagnostics (see <a
> href="#Flymake-error-types">Customizing Flymake error types</a>).</td></tr>
>   <tr><td width="25%"><code>Wait</code></td><td width="75%">Some Flymake
> backends haven&rsquo;t reported since the last time they
>   where questioned.  It is reasonable to assume that this is a temporary
>   delay and Flymake will resume normal operation soon.</td></tr>
>   <tr><td width="25%"><code>!</code></td><td width="75%">All the
> configured Flymake backends have disabled themselves: Flymake
>   cannot annotate the buffer and action from the user is needed to
>   investigate and remedy the situation (see <a
> href="#Troubleshooting">Troubleshooting</a>).</td></tr>
>   <tr><td width="25%"><code>?</code></td><td width="75%">There are no
> applicable Flymake backends for this buffer, thus Flymake
>   cannot annotate it.  To fix this, a user may look to extending Flymake
>   and add a new backend (see <a href="#Extending-Flymake">Extending
> Flymake</a>).</td></tr>
>   </table>
>
> I guess I will ask the Texinfo developers to take a look.
>
> Thanks.
>

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

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Lester Longley <lester <at> ieee.org>
Cc: 72761 <at> debbugs.gnu.org
Subject: Re: bug#72761: issues with Flymake online documentation
Date: Sun, 25 Aug 2024 15:48:15 +0300

> From: Lester Longley <lester <at> ieee.org>
> Date: Fri, 23 Aug 2024 03:40:13 -0400
> Cc: 72761 <at> debbugs.gnu.org
> 
> The following difference seems like it could be relevant.
> 
> As an aside, I have found it more informative to download the .html files and manually inspect them, rather than
> to look at Chrome's Elements tree, since that itself seems to get confused by what appears to me to be a list
> started w/ <table> but ended w/ </ul>.
> 
> In summary, I think that the translation of the @multitable is itself fine, but that the prior presence of @itemize
> @bullet ... , with its mismatch <table> ... </ul>, confuses Chrome. and causes it to (not) render the table (from
> @multitable) properly.
> 
> ----------------------------------------------------------------------------------------
> 
> (a) in the (shorter) https://www.gnu.org/software/emacs/manual/html_node/flymake/Starting-Flymake.html:
> <ul> starts, and </ul> closes, the list, and this documentation "node" renders fine.
> 
>       <p>Syntax checks happen &ldquo;on-the-fly&rdquo;.  Each check is started whenever:
>       </p>
> 
> OK:   <ul class="itemize mark-bullet">
>         <li><code class="code">flymake-mode</code> is started, unless
>           <code class="code">flymake-start-on-flymake-mode</code> is <code class="code">nil</code>;
> 
>         </li><li>the buffer is saved, unless <code class="code">flymake-start-on-save-buffer</code> is
>                <code class="code">nil</code>;
> 
>              </li><li>some changes were made to the buffer more than <code class="code">0.5</code> seconds
> ago
>                                                                                                    (the delay is configurable in <code
> class="code">flymake-no-changes-timeout</code>).
> 
>                   </li><li>When the user invokes the command <code class="code">flymake-start</code>.
> OK:                    </li></ul>
> 
> ----------------------------------------------------------------------------------------
> 
> (b) however, in the (longer & problematic) (mono)
> https://www.gnu.org/software/emacs/manual/html_mono/flymake.html
> 
>           <p>Syntax checks happen &ldquo;on-the-fly&rdquo;.  Each check is started whenever:
>           </p>
> BAD:       <table style="float:left" width="100%">
>             <li> <code>flymake-mode</code> is started, unless
>               <code>flymake-start-on-flymake-mode</code> is <code>nil</code>;
> 
>             </li><li> the buffer is saved, unless <code>flymake-start-on-save-buffer</code> is
>                    <code>nil</code>;
> 
>                  </li><li> some changes were made to the buffer more than <code>0.5</code> seconds ago
>                                                                                            (the delay is configurable in
> <code>flymake-no-changes-timeout</code>).
> 
>                       </li><li> When the user invokes the command <code>flymake-start</code>.
>  OK:                       </li></ul>
> ----------------------------------------------------------------------------------------
> 
> I *guess* that this latter "unclosed" <table> is what causes trouble further down in this file, even though (a new,
>  matching) <table> & </table> match up there.
> (I haven't yet figured out how to rebuild the manuals to do more direct experiments/isolation.)
> ----------------------------------------------------------------------------------------
> 
>           <p>The following statuses are defined:
>           </p>
> OK:          <table>
>             <tr><td width="25%">[<var>nerrors</var> <var>nwarnings</var> ...]</td><td width="75%">Normal
> operation. <var>nerrors</var> and <var>nwarnings</var> are, respectively,
>                                                                                                                                                                 the total
> number of errors and warnings found during the last buffer
>                                                                                                                                                                 check,
> for all backends. They may be followed by other totals for
>                                                                                                                                                                 other
> types of diagnostics (see <a href="#Flymake-error-types">Customizing Flymake error types</a>).</td></tr>
>             <tr><td width="25%"><code>Wait</code></td><td width="75%">Some Flymake backends
> haven&rsquo;t reported since the last time they
>                                                                                                         where questioned.  It is reasonable to
> assume that this is a temporary
>                                                                                                         delay and Flymake will resume normal
> operation soon.</td></tr>
>             <tr><td width="25%"><code>!</code></td><td width="75%">All the configured Flymake backends have
> disabled themselves: Flymake
>                                                                    cannot annotate the buffer and action from the user is needed to
>                                                                    investigate and remedy the situation (see <a
> href="#Troubleshooting">Troubleshooting</a>).</td></tr>
>             <tr><td width="25%"><code>?</code></td><td width="75%">There are no applicable Flymake
> backends for this buffer, thus Flymake
>                                                                    cannot annotate it.  To fix this, a user may look to extending Flymake
>                                                                    and add a new backend (see <a
> href="#Extending-Flymake">Extending Flymake</a>).</td></tr>
>  OK:         </table>

Thanks, I've now fixed the relevant HTML page, and also modified the
script we use to produce HTML manuals to not perform this kind of
"editing" of HTML produced by makeinfo.

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

From: Lester Longley <lester <at> ieee.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 72761 <at> debbugs.gnu.org
Subject: Re: bug#72761: issues with Flymake online documentation
Date: Sun, 25 Aug 2024 10:06:02 -0400

Hi Eli,

On Sun, Aug 25, 2024 at 8:48 AM Eli Zaretskii <eliz <at> gnu.org> wrote:
> Thanks, I've now fixed the relevant HTML page, and also modified the
> script we use to produce HTML manuals to not perform this kind of
> "editing" of HTML produced by makeinfo.

Thank you very much.  The Flymake manuals work fine now, as regards both issues.

(And the update you made to "admin/admin.el" was instructive, for me,
re: the manual-generation infrastructure.)

Regards,
Lester

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Lester Longley <lester <at> ieee.org>
Cc: 72761-done <at> debbugs.gnu.org
Subject: Re: bug#72761: issues with Flymake online documentation
Date: Sat, 31 Aug 2024 12:46:54 +0300

> From: Lester Longley <lester <at> ieee.org>
> Date: Sun, 25 Aug 2024 10:06:02 -0400
> Cc: 72761 <at> debbugs.gnu.org
> 
> Hi Eli,
> 
> On Sun, Aug 25, 2024 at 8:48 AM Eli Zaretskii <eliz <at> gnu.org> wrote:
> > Thanks, I've now fixed the relevant HTML page, and also modified the
> > script we use to produce HTML manuals to not perform this kind of
> > "editing" of HTML produced by makeinfo.
> 
> Thank you very much.  The Flymake manuals work fine now, as regards both issues.
> 
> (And the update you made to "admin/admin.el" was instructive, for me,
> re: the manual-generation infrastructure.)

Thanks, I'm therefore closing this bug.

Previous Next

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