From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Stefan Kangas Newsgroups: gmane.emacs.bugs Subject: bug#44858: [PATCH] Make byte-compiler warn about wide docstrings Date: Sat, 19 Dec 2020 10:50:33 -0600 Message-ID: References: <87zh34wfxo.fsf@gnus.org> <87v9dss2ic.fsf@gnus.org> <83mtyk3ig4.fsf@gnu.org> <83wnxet4z9.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="24484"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 44858@debbugs.gnu.org, larsi@gnus.org To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Dec 19 17:51:11 2020 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 1kqfRm-0006Gv-Rm for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 19 Dec 2020 17:51:10 +0100 Original-Received: from localhost ([::1]:44802 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kqfRl-0001dE-TO for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 19 Dec 2020 11:51:09 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:44552) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kqfRe-0001ao-LU for bug-gnu-emacs@gnu.org; Sat, 19 Dec 2020 11:51:02 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:59715) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1kqfRe-00013N-E8 for bug-gnu-emacs@gnu.org; Sat, 19 Dec 2020 11:51:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1kqfRe-0005Gr-AC for bug-gnu-emacs@gnu.org; Sat, 19 Dec 2020 11:51:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Stefan Kangas Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 19 Dec 2020 16:51:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 44858 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 44858-submit@debbugs.gnu.org id=B44858.160839664320234 (code B ref 44858); Sat, 19 Dec 2020 16:51:02 +0000 Original-Received: (at 44858) by debbugs.gnu.org; 19 Dec 2020 16:50:43 +0000 Original-Received: from localhost ([127.0.0.1]:43028 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kqfRL-0005GH-64 for submit@debbugs.gnu.org; Sat, 19 Dec 2020 11:50:43 -0500 Original-Received: from mail-pl1-f181.google.com ([209.85.214.181]:34065) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kqfRH-0005G0-Ow for 44858@debbugs.gnu.org; Sat, 19 Dec 2020 11:50:42 -0500 Original-Received: by mail-pl1-f181.google.com with SMTP id t6so3128932plq.1 for <44858@debbugs.gnu.org>; Sat, 19 Dec 2020 08:50:39 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:in-reply-to:references:mime-version:date :message-id:subject:to:cc; bh=BCaIFIEmnGdm/gYoefQ9Dy7JjvRWBKue3MXJGQ/62k0=; b=UDBNofWCRJP+U7IoNEG4W2jGLtyKglYy4wH/XmszfPUJnCSliGzGDoyjSG8lyu2pJr vLFbVbSquPBRGg93k1uSG+jyLWG5Jp0wtteK43o4nxHJ+/8VhI01WCQhtk2MOlZYZJuR ZejOOJsHaRk8bgxTQWUvQgrIeQIlQDHLhEOtpiCvtf3jRp4KaAFv+L4i/QCoW8REqkiu 1H1jRdVy5WelkOvCD4bteJFMpfnhKXhoEAjSyELqD8n57ZhTSNYcuDouslI6M7FG6b1c h46phmau4fxE/B6EoDsU8/hWqYJcRHnI26l43syoQhuDxjRr7Jiapr/VhUsx1hkGb3A+ n16Q== X-Gm-Message-State: AOAM532yNSmEfjY3C28Z9MuRi2IJpkOhiFTpditG9+fu87f2/D+p2bhU cUfhGs1RtxrME1iNXumxKb5ifUNIHC1Ib+E+9Wk= X-Google-Smtp-Source: ABdhPJyMXf7U7qwWEApx8lhznp8QebobhafB7WK87fq16b2aSoEpBmiK8tAf65vxEnGqjE/SUBufFfShPZiMGHvuSmQ= X-Received: by 2002:a17:90b:100e:: with SMTP id gm14mr9646447pjb.179.1608396633778; Sat, 19 Dec 2020 08:50:33 -0800 (PST) Original-Received: from 753933720722 named unknown by gmailapi.google.com with HTTPREST; Sat, 19 Dec 2020 10:50:33 -0600 In-Reply-To: <83wnxet4z9.fsf@gnu.org> 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" Xref: news.gmane.io gmane.emacs.bugs:196395 Archived-At: Eli Zaretskii writes: > I see nothing wrong with these, so either I'm missing something or > there's a bug in the code which reports these problems. Thanks for the fixes. See my comments below: >> mh-e/mh-e.el:2827:1: Warning: custom-declare-variable >> `mh-invisible-header-fields' docstring wider than 80 characters >> mh-e/mh-e.el:2850:1: Warning: custom-declare-variable >> `mh-invisible-header-fields-default' docstring wider than 80 characters AFAICT, the offending lines are the ones containing URLs: line 2839: `https://sourceforge.net/tracker/index.php?func=detail&aid=1916032&group_id=13357&atid=113357'). line 2683: `https://sourceforge.net/tracker/index.php?func=detail&aid=1916032&group_id=13357&atid=113357'). I see two issues here: a) The URL does not easily break over two lines. I'm not sure what we should do. Add a special case to ignore lines with URLs? b) The warning doesn't point you to the actually offending line, but to the definition containing the docstring. I'm not sure if this is easily fixable or not, or if it's important enough to be worth spending time on. >> net/dbus.el:79:1: Warning: defconst `dbus-interface-peer' docstring wider than >> 80 characters >> net/dbus.el:91:1: Warning: defconst `dbus-interface-introspectable' docstring >> wider than 80 characters >> net/dbus.el:102:1: Warning: defconst `dbus-interface-properties' docstring >> wider than 80 characters >> net/dbus.el:128:1: Warning: defconst `dbus-interface-objectmanager' docstring >> wider than 80 characters >> net/dbus.el:148:1: Warning: defconst `dbus-interface-monitoring' docstring >> wider than 80 characters Again we have URLs, like on line 81: See URL `https://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-peer'." >> org/org-protocol.el:166:1: Warning: custom-declare-variable >> `org-protocol-project-alist' docstring wider than 80 characters > > I don't see a problem here. I fixed that one. >> progmodes/cc-engine.el:183:1: Warning: defvar `c-vsemi-status-unknown-p-fn' >> docstring wider than 80 characters > > I don't see how I can do anything about this one. I'm also stomped. Perhaps we could ask Alan for help with this one.