From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp10.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms9.migadu.com with LMTPS id EIhABCG/G2QzoQAASxT56A (envelope-from ) for ; Thu, 23 Mar 2023 03:53:21 +0100 Received: from aspmx1.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp10.migadu.com with LMTPS id iPIxAyG/G2T7YAAAG6o9tA (envelope-from ) for ; Thu, 23 Mar 2023 03:53:21 +0100 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id D64502B22E for ; Thu, 23 Mar 2023 03:53:20 +0100 (CET) Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=gmail.com header.s=20210112 header.b=qwhzxtOn; spf=pass (aspmx1.migadu.com: domain of "guix-patches-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-patches-bounces+larch=yhetil.org@gnu.org"; dmarc=fail reason="SPF not aligned (relaxed)" header.from=gmail.com (policy=none) ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1679540000; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:resent-cc:resent-from:resent-sender: resent-message-id:in-reply-to:in-reply-to:references:references: list-id:list-help:list-unsubscribe:list-subscribe:list-post: dkim-signature; bh=rpa11cDpiJPg5CARvR1Lo2dEbTdPIIDNatV9pLdRmnY=; b=ZtacA8jcUD997SrkqCmHPAxaE1jWJ0CVWHP+bVm97FSCDurNtUqtzqf7YC5leT7TUpg9cT Ob0q2xEzyi4sMk/YnIJ4AE/SY8y27cVHyVZMKofIMXZwtFarxBVgAZSQIfG21EVYr9LPft NT5tjQML6XlFRhvHBdyl3lgKIhn2pg7VAFg4GdC97JNE5/mK6ZfhIBUWrqE/IE/ZFbyH+F Cl0gcuwZK4Tzbbymb2cKm/xoBLZ1nrr0I2gqg52CXrdWfTIgvEWiUJwTT4T5qhbI5oJsyy 8WmeKgZDIHbKrTijfRdn2Wd6dIBCELWEBftI8LkAa8Y1oyQwV8Maj4/2WX34yA== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1679540000; a=rsa-sha256; cv=none; b=ZW0hoeTgsPjm6bNexp/KNMxlVvXVKDt1fOhhhjXrlZn4uUWGZiRMFOaod2OpCRPtN4mkJQ 36PzXOAgg3MbrTH06IfuBSdOqD/KKNjw/2zvi4/owt3xKr4kmXCw2NryGaiD9iIbG7YXha EOdckNlsdpVdxTgr5Y1nqn7ojuS9KEqz0EzAsPm5TUc6HUDfu/GpvaGy6xmtecIWE184Jt beEDFzC+KzwvcCKeDRfeuYsj9rWRkPQaXN1zji4EkeAaoWrMTUEB5T2TnsNjNbRV7rF96S WOnWZhPF5kcITHtNNejLHHzKNitZD9FwZGpP4BveT5zkIhjXMNMocx1sxKJLLA== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=gmail.com header.s=20210112 header.b=qwhzxtOn; spf=pass (aspmx1.migadu.com: domain of "guix-patches-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-patches-bounces+larch=yhetil.org@gnu.org"; dmarc=fail reason="SPF not aligned (relaxed)" header.from=gmail.com (policy=none) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pfB4Z-0003bY-6M; Wed, 22 Mar 2023 22:53:03 -0400 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 1pfB4Y-0003bP-Lv for guix-patches@gnu.org; Wed, 22 Mar 2023 22:53:02 -0400 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 1pfB4Y-0001ah-Fw for guix-patches@gnu.org; Wed, 22 Mar 2023 22:53:02 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pfB4Y-0005LD-9J for guix-patches@gnu.org; Wed, 22 Mar 2023 22:53:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#59217] [PATCH] guix: lint: Improve message in linter warning. Resent-From: Maxim Cournoyer Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Thu, 23 Mar 2023 02:53:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 59217 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: Arun Isaac Cc: 59217@debbugs.gnu.org, jgart , zimoun Received: via spool by 59217-submit@debbugs.gnu.org id=B59217.167953997920522 (code B ref 59217); Thu, 23 Mar 2023 02:53:02 +0000 Received: (at 59217) by debbugs.gnu.org; 23 Mar 2023 02:52:59 +0000 Received: from localhost ([127.0.0.1]:37000 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pfB4V-0005Kv-6G for submit@debbugs.gnu.org; Wed, 22 Mar 2023 22:52:59 -0400 Received: from mail-qv1-f45.google.com ([209.85.219.45]:41719) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pfB4T-0005Kh-Hd for 59217@debbugs.gnu.org; Wed, 22 Mar 2023 22:52:58 -0400 Received: by mail-qv1-f45.google.com with SMTP id g9so13406702qvt.8 for <59217@debbugs.gnu.org>; Wed, 22 Mar 2023 19:52:57 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; t=1679539972; h=mime-version:user-agent:message-id:in-reply-to:date:references :subject:cc:to:from:from:to:cc:subject:date:message-id:reply-to; bh=rpa11cDpiJPg5CARvR1Lo2dEbTdPIIDNatV9pLdRmnY=; b=qwhzxtOnOidcoz66Sye4LRzRtVvuhBfiboI51fmwKmg+iI1KKwmkNT1a2seuU5s0AK op6KSqmK4Um4ffFk2Xe5JpokKna8vuBvGi/XwptWSFmu4rSTP4ib4Q+MM6Aqik7Her9J I9bIl0ftiWz1lmyEsamaxApusnto+9pWlHG1VyHptr5lyeX4rV3Ha9t7s0FiDwIG9sxq adtgwff7rwJb/o7QMzTAtH8wNuRhgu4aAwL8kcfrATxsgcLZVdBw5d+IBE4PSukyp4uO DWvr8080Bg8eo2bflylRwwqNxuaeCyEF4sM8Chh+5ImLOxL+7Wju+7flvzSqSPYZKteO ldvQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; t=1679539972; h=mime-version:user-agent:message-id:in-reply-to:date:references :subject:cc:to:from:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=rpa11cDpiJPg5CARvR1Lo2dEbTdPIIDNatV9pLdRmnY=; b=mnkWw42QOOMObTr7VE8bQJTKeUtfCGDpT4114MlCHdPrxbCjrELAsFBfuKP+zBOF8N k3Nnznd2yVo+w6/FPMhAp/uTrSUlYQB7xUwRj7+oiIjktGjiO+OHuZ6nIUku2rZnDidD aqvXv9qsPCb/rQH0Ey9PzXnLmKDSllMWUFJWkmrPSOBJgEdMIAVQQlz5FA0r5w7ft1/+ lRGfpuAHy49trc8yJqKS4Z/QNG8tTD+EBLJdncIbhiNGbBkQmiynl5p14c1u6Qg/oQx5 In/xOg0FwLU7+Wf3qS+xKX4hUsnmNtMSw/iM3vY+yQn3wFVGcJohm3E42DCmzSEMlWV5 qEeA== X-Gm-Message-State: AO0yUKXbM56dxk3af9sydN7YxnaS21dNz4y2TrEM1N/iA2i3BAhMrX+2 2T/H16xi4ThgIgadMfvnyxvbF/q9ALez/A== X-Google-Smtp-Source: AK7set+m2jz8uydt4sHtVc9D3tUyBhI71hV4Dbo+ZQAozQZVQWU/WbtW2AXWIko5dZr1Ml9FMGOMww== X-Received: by 2002:a05:6214:c83:b0:5a6:ecda:bd8d with SMTP id r3-20020a0562140c8300b005a6ecdabd8dmr10055055qvr.4.1679539971814; Wed, 22 Mar 2023 19:52:51 -0700 (PDT) Received: from hurd (dsl-10-130-195.b2b2c.ca. [72.10.130.195]) by smtp.gmail.com with ESMTPSA id w9-20020ac843c9000000b003d8f78b82besm3652337qtn.70.2023.03.22.19.52.51 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 22 Mar 2023 19:52:51 -0700 (PDT) From: Maxim Cournoyer References: <20221112150907.29793-1-jgart@dismail.de> <20221112091515.GB30032@dismail.de> <87wn7mk8pp.fsf@systemreboot.net> <86mt8iashd.fsf@gmail.com> <87bkoxbzoc.fsf@systemreboot.net> <87edphnat3.fsf_-_@gmail.com> <871qlga3ci.fsf@systemreboot.net> Date: Wed, 22 Mar 2023 22:52:50 -0400 In-Reply-To: <871qlga3ci.fsf@systemreboot.net> (Arun Isaac's message of "Wed, 22 Mar 2023 21:22:21 +0000") Message-ID: <878rfofabh.fsf@gmail.com> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.2 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: X-Migadu-Queue-Id: D64502B22E X-Spam-Score: 0.05 X-Migadu-Spam-Score: 0.05 X-Migadu-Scanner: scn0.migadu.com List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+larch=yhetil.org@gnu.org Sender: guix-patches-bounces+larch=yhetil.org@gnu.org X-Migadu-Country: US X-Migadu-Flow: FLOW_IN X-TUID: UTKNRqrjPP8o Hi Arun, Arun Isaac writes: > Hi Maxim, > >> Personally, I'd prefer not having explanations directly in the output of >> Guix lint; it should be terse, as it's involved often and repeatedly. > > I see your point. But, perhaps there should at least be a > link. Something like > > /home/arun/guix/gnu/packages/web.scm:8030:17: tissue@0.1.0: sentences in > description should be followed by two spaces; possible infraction at 313 > (see > https://guix.gnu.org/manual/en/html_node/guix-lint-errors.html#two-spaces > for details) > > Or a lint error code that can be explained in detail in the manual: > > /home/arun/guix/gnu/packages/web.scm:8030:17: tissue@0.1.0: sentences in > description should be followed by two spaces; possible infraction at 313 > (#12345) I think I like the error code more; the link is too verbose to my taste, and I prefer to stay outside of the browser as much as I can ;-). It seems error codes that can be documented somewhere else are common for linters (e.g., pylint). It then also give some way to disable the lint checks by annotating the source with e.g. --8<---------------cut here---------------start------------->8--- ;disable #12345 --8<---------------cut here---------------end--------------->8--- I'm not sure we'd want to do that, but that'd be an option for the future if we had some documented codes for the checks. > Or a --verbose flag that can enable longer explanations. That's another interesting approach. On the bad side, you'd probably often run 'guix lint', then realize you needed --verbose, and have to run it again (and it's slow). > New users should not be baffled by error messages and should have some > way of learning more without having to ask on the mailing list or do > extensive research. I agree there's merit to improving the situation! -- Thanks, Maxim