GNU logs - #59954, boring messages

Message sent to joaotavora@HIDDEN, bug-gnu-emacs@HIDDEN:

Subject: bug#59954: 29.0.50; flymake-reporting-backends documentation could use some work
Resent-From: Stefan Kangas <stefankangas@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: joaotavora@HIDDEN, bug-gnu-emacs@HIDDEN
Resent-Date: Sat, 10 Dec 2022 23:27:01 +0000
Resent-Message-ID: <handler.59954.B.16707147875574 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: 59954 <at> debbugs.gnu.org
Cc: =?UTF-8?Q?Jo=C3=A3o_?= =?UTF-8?Q?T=C3=A1vora?= <joaotavora@HIDDEN>
From: Stefan Kangas <stefankangas@HIDDEN>
MIME-Version: 1.0
Date: Sat, 10 Dec 2022 15:26:18 -0800
Message-ID: <CADwFkmm0oZob7NuB-aBCk2ybf=WSMAUc-UOFgsrTM+As_H7vRg@HIDDEN>
Content-Type: text/plain; charset="UTF-8"
Received-SPF: pass client-ip=2001:4860:4864:20::35;
 envelope-from=stefankangas@HIDDEN; helo=mail-oa1-x35.google.com
X-Spam_score_int: -20
X-Spam_score: -2.1
X-Spam_bar: --
X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1,
 DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001,
 RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001,
 SPF_PASS=-0.001 autolearn=ham autolearn_force=no
X-Spam_action: no action
X-Spam-Score: -1.3 (-)
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -2.3 (--)

From reading its documentation, I don't understand what the
`flymake-reporting-backends' command does.

The docstring of `flymake-reporting-backends' says:

    Compute reporting Flymake backends in current buffer.

It is also not really explained in (info "(flymake) Troubleshooting").
More precisely, I think it must be spelled out how it's different from
`flymake-running-backends', and in which situations one would want to
use one or the other.

I understand that the "reporting" ones are basically the union of the
running and disabled ones, right?  But why are they considered
"reporting"?  That is not immediately clear to me.  Surely if they are
disabled, they are *not* reporting?  This could use some explanation.

Also, why does the docstring of `flymake-running-backends' and
`flymake-disabled-backends' talk about "computing backends", instead of
simply saying that it "displays" the running/disabled backends?

On a side note, and not necessarily part of this bug report, it would
also be useful with some documentation that says to find out more about
a particular back-end.  Currently, I guess `C-h f' is the recommended
way to do that?

Message sent:

Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-Mailer: MIME-tools 5.505 (Entity 5.505)
Content-Type: text/plain; charset=utf-8
X-Loop: help-debbugs@HIDDEN
From: help-debbugs@HIDDEN (GNU bug Tracking System)
To: Stefan Kangas <stefankangas@HIDDEN>
Subject: bug#59954: Acknowledgement (29.0.50; flymake-reporting-backends
 documentation could use some work)
Message-ID: <handler.59954.B.16707147875574.ack <at> debbugs.gnu.org>
References: <CADwFkmm0oZob7NuB-aBCk2ybf=WSMAUc-UOFgsrTM+As_H7vRg@HIDDEN>
X-Gnu-PR-Message: ack 59954
X-Gnu-PR-Package: emacs
Reply-To: 59954 <at> debbugs.gnu.org
Date: Sat, 10 Dec 2022 23:27:01 +0000

Thank you for filing a new bug report with debbugs.gnu.org.

This is an automatically generated reply to let you know your message
has been received.

Your message is being forwarded to the package maintainers and other
interested parties for their attention; they will reply in due course.

As you requested using X-Debbugs-CC, your message was also forwarded to
  Jo=C3=A3o T=C3=A1vora <joaotavora@HIDDEN>
(after having been given a bug report number, if it did not have one).

Your message has been sent to the package maintainer(s):
 bug-gnu-emacs@HIDDEN

If you wish to submit further information on this problem, please
send it to 59954 <at> debbugs.gnu.org.

Please do not send mail to help-debbugs@HIDDEN unless you wish
to report a problem with the Bug-tracking system.

--=20
59954: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D59954
GNU Bug Tracking System
Contact help-debbugs@HIDDEN with problems

Message sent to bug-gnu-emacs@HIDDEN:

Subject: bug#59954: 29.0.50; flymake-reporting-backends documentation could use some work
Resent-From: =?UTF-8?Q?Jo=C3=A3o_?= =?UTF-8?Q?T=C3=A1vora?= <joaotavora@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Sun, 11 Dec 2022 11:28:01 +0000
Resent-Message-ID: <handler.59954.B59954.16707580443241 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: Stefan Kangas <stefankangas@HIDDEN>
Cc: 59954 <at> debbugs.gnu.org
From: =?UTF-8?Q?Jo=C3=A3o_?= =?UTF-8?Q?T=C3=A1vora?= <joaotavora@HIDDEN>
In-Reply-To: <CADwFkmm0oZob7NuB-aBCk2ybf=WSMAUc-UOFgsrTM+As_H7vRg@HIDDEN>
 (Stefan Kangas's message of "Sat, 10 Dec 2022 15:26:18 -0800")
References: <CADwFkmm0oZob7NuB-aBCk2ybf=WSMAUc-UOFgsrTM+As_H7vRg@HIDDEN>
Date: Sun, 11 Dec 2022 11:28:38 +0000
Message-ID: <87edt6gowp.fsf@HIDDEN>
User-Agent: Gnus/5.13 (Gnus v5.13)
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
Precedence: list
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>

Stefan Kangas <stefankangas@HIDDEN> writes:

> The docstring of `flymake-reporting-backends' says:
>
>     Compute reporting Flymake backends in current buffer.

From all the Flymake backends present in `flymake-diagnostic-functions',
the "reporting" ones are the ones that have reported back, i.e. called
their REPORT-FN arguments.

The distinction is (mildly) useful because the Lisp function that
implements them always returns, but that doesn't necessarily mean that
the backend has arranged for the REPORT-FN callback to be called.  When
it is called, the backend enters the "reporting set".

> It is also not really explained in (info "(flymake) Troubleshooting").
> More precisely, I think it must be spelled out how it's different from
> `flymake-running-backends', and in which situations one would want to
> use one or the other.

A "running" backend is simply a backend which has been activated

> I understand that the "reporting" ones are basically the union of the
> running and disabled ones, right?

Not necessarily.  A backend may be running and we haven't yet decided if
it will become a reporting backend or a disabled one.

> "reporting"?  That is not immediately clear to me.  Surely if they are
> disabled, they are *not* reporting?  This could use some explanation.

Best explanation is in these notes and in the code.  There is partially
a historical rationale, as I was trying to keep the visual interface of
the old Flymake reasonably intact, and AFAIR it had representation for
all these states.

But there is also a fair bit of overengineering here.  It makes sense to
represent the states internally, but I've never ever found those
interactive functions useful.  Maybe a bit in the early days of
debugging... IMO you could just trash them or redesign them into a
tabulated list or something.

Jo=C3=A3o

Message sent to bug-gnu-emacs@HIDDEN:

Subject: bug#59954: 29.0.50; flymake-reporting-backends documentation could use some work
Resent-From: =?UTF-8?Q?Jo=C3=A3o_?= =?UTF-8?Q?T=C3=A1vora?= <joaotavora@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Sun, 11 Dec 2022 11:36:02 +0000
Resent-Message-ID: <handler.59954.B59954.16707585403623 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: Stefan Kangas <stefankangas@HIDDEN>
Cc: 59954 <at> debbugs.gnu.org
From: =?UTF-8?Q?Jo=C3=A3o_?= =?UTF-8?Q?T=C3=A1vora?= <joaotavora@HIDDEN>
In-Reply-To: <CADwFkmm0oZob7NuB-aBCk2ybf=WSMAUc-UOFgsrTM+As_H7vRg@HIDDEN>
 (Stefan Kangas's message of "Sat, 10 Dec 2022 15:26:18 -0800")
References: <CADwFkmm0oZob7NuB-aBCk2ybf=WSMAUc-UOFgsrTM+As_H7vRg@HIDDEN>
Date: Sun, 11 Dec 2022 11:36:51 +0000
Message-ID: <87a63ugoj0.fsf@HIDDEN>
User-Agent: Gnus/5.13 (Gnus v5.13)
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
Precedence: list
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>

Stefan Kangas <stefankangas@HIDDEN> writes:

> On a side note, and not necessarily part of this bug report, it would
> also be useful with some documentation that says to find out more about
> a particular back-end.  Currently, I guess `C-h f' is the recommended
> way to do that?

Yes.  describe-function (C-h f) is the right way because back-ends are
represented by functions.  You can invent a M-x flymake-describe-backend
with a different completion set, but it should funnel to M-x
describe-function and give the very same output.

On a related note, you can see that in the commands M-x
flymake-show-[buffer|project]-diagnostics, the backend's itself is
represented in a column.  Currently this name is synthesized from the
initials of the symbol name bound to the function.  This works well as a
default, but it could be augmented:

For example:

* There could be a 'flymake-backend-name' property on the symbols for
  an extra indirection or better names

* Clicking the name in that report could bring up the same thing as C-h
  f, effectively describing the backend.

Jo=C3=A3o

Message received at control <at> debbugs.gnu.org:

Received: (at control) by debbugs.gnu.org; 4 Sep 2023 15:18:13 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Mon Sep 04 11:18:13 2023
Received: from localhost ([127.0.0.1]:52256 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1qdBLB-0002eI-Gf
	for submit <at> debbugs.gnu.org; Mon, 04 Sep 2023 11:18:13 -0400
Received: from mail-lj1-x236.google.com ([2a00:1450:4864:20::236]:57848)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <stefankangas@HIDDEN>) id 1qdBL9-0002dx-Nm
 for control <at> debbugs.gnu.org; Mon, 04 Sep 2023 11:18:12 -0400
Received: by mail-lj1-x236.google.com with SMTP id
 38308e7fff4ca-2bd0d135ca3so25834931fa.3
 for <control <at> debbugs.gnu.org>; Mon, 04 Sep 2023 08:18:11 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=gmail.com; s=20221208; t=1693840686; x=1694445486; darn=debbugs.gnu.org;
 h=to:subject:message-id:date:mime-version:from:from:to:cc:subject
 :date:message-id:reply-to;
 bh=PAwwm710vfc5E/SOcUEfnOZujpChIN83qJyKOi4xk2E=;
 b=cw7cpD5ys/IT4gVqXqHtZvVovG51ixKEUrB26+NJErHkcwFhFKp3DaTgt+JegORk/5
 d7M4MbgDU38T9cMflu2zlN+moIwfe7PqEbOoeIrKVQeBONFznBz/g+mHWxaHY0FeXL5A
 Q8ln5vn1uNb5cA0YDBD3BRSg1Ps8FGCLJstyRkljy012SYHOaQHfMi6gGFLBZ0mRa9T4
 ezCQJL28gNq/FaOPPmTQAl6SeyvNHTgEIwpmrxvy5NuCiKMnfnqIKnDjeZKELOaMbB1v
 g7z+6LbumBpRCtxvolHomE3A1LyKs5S0qqWFLokJgrtLK9wrpZWgKppkljfZu9DDxtGb
 6NRw==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20221208; t=1693840686; x=1694445486;
 h=to:subject:message-id:date:mime-version:from:x-gm-message-state
 :from:to:cc:subject:date:message-id:reply-to;
 bh=PAwwm710vfc5E/SOcUEfnOZujpChIN83qJyKOi4xk2E=;
 b=l6LaBWiM0AdPFaZBuR1tojV7MpYMCjQvSA1rPUJnhrdPaC3XEHSr/k015t+bOSrPNO
 Tjjvif+w+hJh+P1leFMhI9H89xGJBSwmrlhb+y1kdwU3oklSSyMfjhrYmi/A1IfcEVlr
 9Tu5gwHNKsqFC2TeAKVbEoMi6lb/rWaEcTHlTGCYNfduyIQDoWKJotPBRrYZ/2TUdwFX
 OAqZJI2Hz11tTdKwUmqUvDqWbM4Vc7Ve535tcy+iHsJD9+thJOwM3u2lK9lQ7BQswNgM
 cHXKYionhjGY6C0fYovBrL/9Xx8hCAoyB10XNnBOhVztL82K/nTQJMRt6959TXJsKTsn
 Qxig==
X-Gm-Message-State: AOJu0YwIlZxBYclPsqz1BPrJPV1F8CGTiaVhltNELSPWBG5Mv7m2ZJnd
 53OAmm+drOLy+8ianhmEWL0+gR+gxAa1KywitQzqelzo
X-Google-Smtp-Source: AGHT+IHNK3fsjvbkUAww9F2JDzyuI7UKgBPnCiCuCbrL3H01yjpbyi8e2s257oGbKk0E52PrAPZAQ2ikFfOSWn8zHC8=
X-Received: by 2002:a2e:7015:0:b0:2bd:ddf:8aa7 with SMTP id
 l21-20020a2e7015000000b002bd0ddf8aa7mr7066084ljc.0.1693840685697; Mon, 04 Sep
 2023 08:18:05 -0700 (PDT)
Received: from 753933720722 named unknown by gmailapi.google.com with
 HTTPREST; Mon, 4 Sep 2023 08:18:05 -0700
From: Stefan Kangas <stefankangas@HIDDEN>
MIME-Version: 1.0
Date: Mon, 4 Sep 2023 08:18:05 -0700
Message-ID: <CADwFkm=VNSEF-74eCL6dKx5CUErMW8MG6pDB9wQ-GbQnJJM3qw@HIDDEN>
Subject: control message for bug #59954
To: control <at> debbugs.gnu.org
Content-Type: text/plain; charset="UTF-8"
X-Spam-Score: 0.0 (/)
X-Debbugs-Envelope-To: control
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -1.0 (-)

severity 59954 wishlist
quit

Last modified: Mon, 4 Sep 2023 15:30:02 UTC

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