From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: =?UTF-8?Q?Jo=C3=A3o_?= =?UTF-8?Q?T=C3=A1vora?= Newsgroups: gmane.emacs.bugs Subject: bug#59954: 29.0.50; flymake-reporting-backends documentation could use some work Date: Sun, 11 Dec 2022 11:28:38 +0000 Message-ID: <87edt6gowp.fsf@gmail.com> References: Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="20240"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Cc: 59954@debbugs.gnu.org To: Stefan Kangas Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun Dec 11 12:28:26 2022 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1p4KVO-00052b-9n for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 11 Dec 2022 12:28:26 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1p4KV4-0002EP-TP; Sun, 11 Dec 2022 06:28:06 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1p4KV3-0002EA-6A for bug-gnu-emacs@gnu.org; Sun, 11 Dec 2022 06:28:05 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1p4KV0-0003ls-17 for bug-gnu-emacs@gnu.org; Sun, 11 Dec 2022 06:28:04 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1p4KUz-0000qT-J7 for bug-gnu-emacs@gnu.org; Sun, 11 Dec 2022 06:28:01 -0500 X-Loop: help-debbugs@gnu.org Resent-From: =?UTF-8?Q?Jo=C3=A3o_?= =?UTF-8?Q?T=C3=A1vora?= Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 11 Dec 2022 11:28:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 59954 X-GNU-PR-Package: emacs Original-Received: via spool by 59954-submit@debbugs.gnu.org id=B59954.16707580443241 (code B ref 59954); Sun, 11 Dec 2022 11:28:01 +0000 Original-Received: (at 59954) by debbugs.gnu.org; 11 Dec 2022 11:27:24 +0000 Original-Received: from localhost ([127.0.0.1]:46340 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1p4KUO-0000qD-8Y for submit@debbugs.gnu.org; Sun, 11 Dec 2022 06:27:24 -0500 Original-Received: from mail-wm1-f42.google.com ([209.85.128.42]:40569) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1p4KUL-0000q6-FU for 59954@debbugs.gnu.org; Sun, 11 Dec 2022 06:27:22 -0500 Original-Received: by mail-wm1-f42.google.com with SMTP id v124-20020a1cac82000000b003cf7a4ea2caso2876747wme.5 for <59954@debbugs.gnu.org>; Sun, 11 Dec 2022 03:27:21 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:user-agent:message-id:date :references:in-reply-to:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=hFzRyEbHJaGgkUETHc2YFyVngsuqskqgIJ3FMIxRv9E=; b=N2CGQmUMu+p81dm5oTOvLcUHYPNXF2gc0QWu3H2/7alRT9/IpfJ0HdAOeX6fAQimfU Js/ImaI2/YggmwmD9/GT3awhyGJ95q3AXpD8E/oq+GC2LVEP/0Opksxqp1lhGSEj/mgx pLiDsMIjZbzsbdIGNGuXQjieKWaKUC7cRqyP/JhNvFXAmYlaGxk+u/o/nQNvgCDMze1j z/NyPeLOmdne0Xg2jKbU2Vg+XrpWBZZ6LM8yrSDQQecsUlgU2tdld+b2KwB0Om04MNZk e72sJwwdQFjL/QKSu6Xqw6vUJz3s/8sjvExDP9bl0DP9R+olHrWdRxUlukUfhDC+Q3RG EUtg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:user-agent:message-id:date :references:in-reply-to:subject:cc:to:from:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=hFzRyEbHJaGgkUETHc2YFyVngsuqskqgIJ3FMIxRv9E=; b=okpDR5Kv5cNUEJLh7NQbjUxGfULVoNeQGEnq65vGPYztv9ZgkbegH1KOzHkBAjTIiz zUri0PeiQlekrVI9cc2qygdMrT2MocZ1OedCm53o/G1sxjj4d1o5bjb5wCiEC2F4OYOZ XxbFJT7cBmWgZ4ad+yU7FGVz3PimmNJFHBRXZwT23INJ8jkXN8lKu0s8op6hrisS+7x/ u5Ute57DZZ3xTEp+EWp/IrbD2fa9Zuk0mD07DC5L0BgvO05ZJIFohHVgx7Fvb0dpy669 jfZA8NYYpeom+d2zYD7W+4xouMCUlkSG7mZX4FlHFqYuIrkHX7zcQyVJUfrea59a2n8k +wKw== X-Gm-Message-State: ANoB5plGaMDt3mGw7zivgwl7k38HhUWFqI/uA+rxp06ldPyHQyH6Gudy Vg6QO7xwSAVvyz+aVZejpAcAkrjVBOfEHg== X-Google-Smtp-Source: AA0mqf40OluLq/zaZG2ug2fxvD/jF7XS40WLuGRCRZqOt5017sIVH+UYaKZzyO44EGoDtFpAJrNo7A== X-Received: by 2002:a1c:f216:0:b0:3c6:e60f:3f6f with SMTP id s22-20020a1cf216000000b003c6e60f3f6fmr9705064wmc.38.1670758035241; Sun, 11 Dec 2022 03:27:15 -0800 (PST) Original-Received: from krug ([87.196.73.60]) by smtp.gmail.com with ESMTPSA id q24-20020a056000137800b002428c4fb16asm6077843wrz.10.2022.12.11.03.27.14 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 11 Dec 2022 03:27:14 -0800 (PST) In-Reply-To: (Stefan Kangas's message of "Sat, 10 Dec 2022 15:26:18 -0800") X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:250596 Archived-At: Stefan Kangas 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