GNU bug report logs - #42425
26.3.50; Compilation warnings when compiling eldoc.el under Emacs 26.3

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 42425 in the body.
You can then email your comments to 42425 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: Philipp Stephani <p.stephani2 <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 26.3.50; Compilation warnings when compiling eldoc.el under Emacs 26.3
Date: Sun, 19 Jul 2020 10:12:21 +0200

eldoc is now a separate package that claims to support Emacs 26.3.
However, compiling eldoc.el results in a few warnings:

emacs -Q -batch -l bytecomp -f batch-byte-compile eldoc.el

In eldoc--eval-expression-setup:
eldoc.el:236:9:Warning: assignment to free variable
    ‘eldoc-documentation-strategy’

In eldoc--supported-p:
eldoc.el:615:19:Warning: reference to free variable
    ‘eldoc-documentation-strategy’

In eldoc--invoke-strategy:
eldoc.el:732:28:Warning: reference to free variable
    ‘eldoc-documentation-strategy’

In end of data:
eldoc.el:804:1:Warning: the following functions are not known to be defined:
    elisp-eldoc-var-docstring, elisp-eldoc-funcall

1. Probably the definition of `eldoc-documentation-strategy' needs to be
   moved before its first use.

2. Probably eldoc should protect against newer Elisp functions being not
   yet available, as calling such functions will likely result in errors
   at runtime.


In GNU Emacs 26.3.50 (build 1, x86_64-pc-linux-gnu, GTK+ Version 3.24.14)
 of 2020-06-29
Repository revision: 7497ee44b471f69ce59d131a6dece261e871534f
Windowing system distributor 'The X.Org Foundation', version 11.0.12008000
System Description:	Debian GNU/Linux rodete

Recent messages:
For information about GNU Emacs and the GNU system, type C-h C-a.
Eager macro-expansion failure: (error "Unknown seq pattern: (seq 3 (pred (lambda (c) (and (characterp c) (= (aref (symbol-name (category c)) 0) 76)))))")

Configured using:
 'configure --enable-checking --enable-gtk-deprecation-warnings
 --enable-gcc-warnings=warn-only --with-modules --without-pop
 --with-mailutils --enable-check-lisp-object-type 'CFLAGS=-ggdb3 -O0''

Configured features:
XPM JPEG TIFF GIF PNG SOUND DBUS GSETTINGS GLIB NOTIFY LIBSELINUX GNUTLS
FREETYPE XFT ZLIB TOOLKIT_SCROLL_BARS GTK3 X11 XDBE XIM MODULES THREADS

Important settings:
  value of $LANG: en_US.utf8
  value of $XMODIFIERS: @im=ibus
  locale-coding-system: utf-8-unix

Major mode: Lisp Interaction

Minor modes in effect:
  tooltip-mode: t
  global-eldoc-mode: t
  eldoc-mode: t
  electric-indent-mode: t
  mouse-wheel-mode: t
  tool-bar-mode: t
  menu-bar-mode: t
  file-name-shadow-mode: t
  global-font-lock-mode: t
  font-lock-mode: t
  blink-cursor-mode: t
  auto-composition-mode: t
  auto-encryption-mode: t
  auto-compression-mode: t
  line-number-mode: t
  transient-mark-mode: t

Load-path shadows:
None found.

Features:
(shadow sort mail-extr emacsbug message rmc puny seq dired
dired-loaddefs format-spec rfc822 mml easymenu mml-sec epa epg
epg-config gnus-util rmail rmail-loaddefs mm-decode mm-bodies mm-encode
mail-parse rfc2231 mailabbrev gmm-utils mailheader sendmail rfc2047
rfc2045 ietf-drums mm-util mail-prsvr mail-utils phst skeleton derived
edmacro kmacro pcase ffap thingatpt url url-proxy url-privacy url-expand
url-methods url-history url-cookie url-domsuf url-util url-parse
auth-source cl-seq eieio byte-opt bytecomp byte-compile cconv eieio-core
cl-macs gv eieio-loaddefs password-cache url-vars mailcap subr-x rx
gnutls dbus xml compile comint ansi-color ring cl-loaddefs cl-lib
elec-pair time-date mule-util tooltip eldoc electric uniquify ediff-hook
vc-hooks lisp-float-type mwheel term/x-win x-win term/common-win x-dnd
tool-bar dnd fontset image regexp-opt fringe tabulated-list replace
newcomment text-mode elisp-mode lisp-mode prog-mode register page
menu-bar rfn-eshadow isearch timer select scroll-bar mouse jit-lock
font-lock syntax facemenu font-core term/tty-colors frame cl-generic
cham georgian utf-8-lang misc-lang vietnamese tibetan thai tai-viet lao
korean japanese eucjp-ms cp51932 hebrew greek romanian slovak czech
european ethiopic indian cyrillic chinese composite charscript charprop
case-table epa-hook jka-cmpr-hook help simple abbrev obarray minibuffer
cl-preloaded nadvice loaddefs button faces cus-face macroexp files
text-properties overlay sha1 md5 base64 format env code-pages mule
custom widget hashtable-print-readable backquote threads dbusbind
inotify dynamic-setting system-font-setting font-render-setting
move-toolbar gtk x-toolkit x multi-tty make-network-process emacs)

Memory information:
((conses 16 117319 5856)
 (symbols 48 22667 1)
 (miscs 40 42 114)
 (strings 32 35666 1100)
 (string-bytes 1 970671)
 (vectors 16 17078)
 (vector-slots 8 536734 16344)
 (floats 8 54 68)
 (intervals 56 221 0)
 (buffers 992 12))

-- 
Google Germany GmbH
Erika-Mann-Straße 33
80636 München

Geschäftsführer: Paul Manicle, Halimah DeLaine Prado
Registergericht und -nummer: Hamburg, HRB 86891
Sitz der Gesellschaft: Hamburg

Diese E-Mail ist vertraulich.  Falls Sie diese fälschlicherweise erhalten haben
sollten, leiten Sie diese bitte nicht an jemand anderes weiter, löschen Sie
alle Kopien und Anhänge davon und lassen Sie mich bitte wissen, dass die E-Mail
an die falsche Person gesendet wurde.

This e-mail is confidential.  If you received this communication by mistake,
please don’t forward it to anyone else, please erase all copies and
attachments, and please let me know that it has gone to the wrong person.

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Philipp Stephani <p.stephani2 <at> gmail.com>
Cc: 42425 <at> debbugs.gnu.org,
 João Távora <joaotavora <at> gmail.com>
Subject: Re: bug#42425: 26.3.50; Compilation warnings when compiling
 eldoc.el under Emacs 26.3
Date: Fri, 22 Jan 2021 20:58:51 +0100

Philipp Stephani <p.stephani2 <at> gmail.com> writes:

> eldoc is now a separate package that claims to support Emacs 26.3.
> However, compiling eldoc.el results in a few warnings:
>
> emacs -Q -batch -l bytecomp -f batch-byte-compile eldoc.el
>
> In eldoc--eval-expression-setup:
> eldoc.el:236:9:Warning: assignment to free variable
>     ‘eldoc-documentation-strategy’
>
> In eldoc--supported-p:
> eldoc.el:615:19:Warning: reference to free variable
>     ‘eldoc-documentation-strategy’
>
> In eldoc--invoke-strategy:
> eldoc.el:732:28:Warning: reference to free variable
>     ‘eldoc-documentation-strategy’
>
> In end of data:
> eldoc.el:804:1:Warning: the following functions are not known to be defined:
>     elisp-eldoc-var-docstring, elisp-eldoc-funcall
>
> 1. Probably the definition of `eldoc-documentation-strategy' needs to be
>    moved before its first use.

Doing so seems easy enough, but I'm not sure how high our ambitions are
for doing warning-free ELPA packages on older Emacs versions?  (I've
added João to the CCs.)

> 2. Probably eldoc should protect against newer Elisp functions being not
>    yet available, as calling such functions will likely result in errors
>    at runtime.

Doesn't it do that?  What functions is it using that's not available?

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

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

From: João Távora <joaotavora <at> gmail.com>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: Philipp Stephani <p.stephani2 <at> gmail.com>, 42425 <at> debbugs.gnu.org
Subject: Re: bug#42425: 26.3.50; Compilation warnings when compiling eldoc.el
 under Emacs 26.3
Date: Fri, 22 Jan 2021 20:22:10 +0000

Hi

The warnings are better than breaking it :-) I don't remember
the details right now, but the backward compatibility to Emacs 26.3
is held up by very fine strings with aliasing and stuff.

So make sure you read the surrounding comments and commit
messages closely before attempting anything.  I remember
documenting stuff there.

Sorry, I can't be of more help right now.
João

On Fri, Jan 22, 2021 at 7:58 PM Lars Ingebrigtsen <larsi <at> gnus.org> wrote:
>
> Philipp Stephani <p.stephani2 <at> gmail.com> writes:
>
> > eldoc is now a separate package that claims to support Emacs 26.3.
> > However, compiling eldoc.el results in a few warnings:
> >
> > emacs -Q -batch -l bytecomp -f batch-byte-compile eldoc.el
> >
> > In eldoc--eval-expression-setup:
> > eldoc.el:236:9:Warning: assignment to free variable
> >     ‘eldoc-documentation-strategy’
> >
> > In eldoc--supported-p:
> > eldoc.el:615:19:Warning: reference to free variable
> >     ‘eldoc-documentation-strategy’
> >
> > In eldoc--invoke-strategy:
> > eldoc.el:732:28:Warning: reference to free variable
> >     ‘eldoc-documentation-strategy’
> >
> > In end of data:
> > eldoc.el:804:1:Warning: the following functions are not known to be defined:
> >     elisp-eldoc-var-docstring, elisp-eldoc-funcall
> >
> > 1. Probably the definition of `eldoc-documentation-strategy' needs to be
> >    moved before its first use.
>
> Doing so seems easy enough, but I'm not sure how high our ambitions are
> for doing warning-free ELPA packages on older Emacs versions?  (I've
> added João to the CCs.)
>
> > 2. Probably eldoc should protect against newer Elisp functions being not
> >    yet available, as calling such functions will likely result in errors
> >    at runtime.
>
> Doesn't it do that?  What functions is it using that's not available?
>
> --
> (domestic pets only, the antidote for overdose, milk.)
>    bloggy blog: http://lars.ingebrigtsen.no



-- 
João Távora

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

From: Philipp Stephani <p.stephani2 <at> gmail.com>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 42425 <at> debbugs.gnu.org,
 João Távora <joaotavora <at> gmail.com>
Subject: Re: bug#42425: 26.3.50; Compilation warnings when compiling eldoc.el
 under Emacs 26.3
Date: Sat, 23 Jan 2021 18:35:07 +0100

Am Fr., 22. Jan. 2021 um 20:58 Uhr schrieb Lars Ingebrigtsen <larsi <at> gnus.org>:
>
> Philipp Stephani <p.stephani2 <at> gmail.com> writes:
>
> > eldoc is now a separate package that claims to support Emacs 26.3.
> > However, compiling eldoc.el results in a few warnings:
> >
> > emacs -Q -batch -l bytecomp -f batch-byte-compile eldoc.el
> >
> > In eldoc--eval-expression-setup:
> > eldoc.el:236:9:Warning: assignment to free variable
> >     ‘eldoc-documentation-strategy’
> >
> > In eldoc--supported-p:
> > eldoc.el:615:19:Warning: reference to free variable
> >     ‘eldoc-documentation-strategy’
> >
> > In eldoc--invoke-strategy:
> > eldoc.el:732:28:Warning: reference to free variable
> >     ‘eldoc-documentation-strategy’
> >
> > In end of data:
> > eldoc.el:804:1:Warning: the following functions are not known to be defined:
> >     elisp-eldoc-var-docstring, elisp-eldoc-funcall
> >
> > 1. Probably the definition of `eldoc-documentation-strategy' needs to be
> >    moved before its first use.
>
> Doing so seems easy enough, but I'm not sure how high our ambitions are
> for doing warning-free ELPA packages on older Emacs versions?  (I've
> added João to the CCs.)

I think our ambitions should be quite high. (I personally think we
should treat almost all compiler warnings as errors/bugs and fix them
whenever realistically possible.)

>
> > 2. Probably eldoc should protect against newer Elisp functions being not
> >    yet available, as calling such functions will likely result in errors
> >    at runtime.
>
> Doesn't it do that?  What functions is it using that's not available?

At least the current master version looks fine, though the byte
compiler isn't smart enough to detect that. The problematic uses are
in eldoc--eval-expression-setup.

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

From: João Távora <joaotavora <at> gmail.com>
To: Philipp Stephani <p.stephani2 <at> gmail.com>,
 Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: Lars Ingebrigtsen <larsi <at> gnus.org>, 42425 <at> debbugs.gnu.org
Subject: Re: bug#42425: 26.3.50; Compilation warnings when compiling eldoc.el
 under Emacs 26.3
Date: Sat, 23 Jan 2021 17:53:48 +0000

On Sat, Jan 23, 2021 at 5:35 PM Philipp Stephani <p.stephani2 <at> gmail.com> wrote:
>
> Am Fr., 22. Jan. 2021 um 20:58 Uhr schrieb Lars Ingebrigtsen <larsi <at> gnus.org>:
> >
> > Philipp Stephani <p.stephani2 <at> gmail.com> writes:
> >
> > > eldoc is now a separate package that claims to support Emacs 26.3.
> > > However, compiling eldoc.el results in a few warnings:
> > >
> > > emacs -Q -batch -l bytecomp -f batch-byte-compile eldoc.el
> > >
> > > In eldoc--eval-expression-setup:
> > > eldoc.el:236:9:Warning: assignment to free variable
> > >     ‘eldoc-documentation-strategy’
> > >
> > > In eldoc--supported-p:
> > > eldoc.el:615:19:Warning: reference to free variable
> > >     ‘eldoc-documentation-strategy’
> > >
> > > In eldoc--invoke-strategy:
> > > eldoc.el:732:28:Warning: reference to free variable
> > >     ‘eldoc-documentation-strategy’
> > >
> > > In end of data:
> > > eldoc.el:804:1:Warning: the following functions are not known to be defined:
> > >     elisp-eldoc-var-docstring, elisp-eldoc-funcall
> > >
> > > 1. Probably the definition of `eldoc-documentation-strategy' needs to be
> > >    moved before its first use.
> >
> > Doing so seems easy enough, but I'm not sure how high our ambitions are
> > for doing warning-free ELPA packages on older Emacs versions?  (I've
> > added João to the CCs.)
>
> I think our ambitions should be quite high. (I personally think we
> should treat almost all compiler warnings as errors/bugs and fix them
> whenever realistically possible.)

I agree, but with strong emphasis on the realism bit.  So if you can fix this
and not break the master, 28 + ELPA, 27.1 + ELPA, 26.3 + ELPA cases, I'm
fine with it.

Just noting that shushing a warning is not the same as "fixing" it, but
of course you know that.

I remember there being extra trouble because eldoc.el is preloaded
(because it is required by elisp-mode.el, which is also preloaded).

Maybe the warnings you are bringing up have nothing to do with this,
though.

Another note, it must compile in version X and load in that version X.
This has to be able to happen in the same session or in separate sessions.
so you have 4 test cases per version.

When aliasing some variables for backward compat, there were problems
because of that. I think the direction of the alias is different in 26 and 27,
or something like that.  In practice it makes no difference: code referencing
that name points to the same thing, though the thing is different in 26 and 27.

Extra credit if you can avoid pre-loading Eldoc altogether.   CC'in
Stefan cause I think he had some input on that (sorry for the noise if I'm
mistaken,Stefan).

Good luck, João

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Philipp Stephani <p.stephani2 <at> gmail.com>
Cc: 42425 <at> debbugs.gnu.org,
 João Távora <joaotavora <at> gmail.com>
Subject: Re: bug#42425: 26.3.50; Compilation warnings when compiling
 eldoc.el under Emacs 26.3
Date: Sat, 23 Jan 2021 19:31:27 +0100

Philipp Stephani <p.stephani2 <at> gmail.com> writes:

>> Doing so seems easy enough, but I'm not sure how high our ambitions are
>> for doing warning-free ELPA packages on older Emacs versions?  (I've
>> added João to the CCs.)
>
> I think our ambitions should be quite high. (I personally think we
> should treat almost all compiler warnings as errors/bugs and fix them
> whenever realistically possible.)

Building Emacs has traditionally been watching a wall of warnings scroll
by.  This has recently changed, but shows that "no warnings" isn't a
value held universally by the Emacs developers.

I think that the Emacs build should be warning free -- on our main,
current targets.  Jumping through hoops to avoid warnings on older Emacs
versions normally isn't worth spending time on, in my opinion.

But we really have no policy here.

>> > 2. Probably eldoc should protect against newer Elisp functions being not
>> >    yet available, as calling such functions will likely result in errors
>> >    at runtime.
>>
>> Doesn't it do that?  What functions is it using that's not available?
>
> At least the current master version looks fine, though the byte
> compiler isn't smart enough to detect that. The problematic uses are
> in eldoc--eval-expression-setup.

I'm not sure I follow you here -- are you saying that eldoc doesn't work
on Emacs 26 because of the usages in `eldoc--eval-expression-setup'?

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

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

From: Philipp Stephani <p.stephani2 <at> gmail.com>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 42425 <at> debbugs.gnu.org,
 João Távora <joaotavora <at> gmail.com>
Subject: Re: bug#42425: 26.3.50; Compilation warnings when compiling eldoc.el
 under Emacs 26.3
Date: Sun, 24 Jan 2021 10:30:37 +0100

Am Sa., 23. Jan. 2021 um 19:31 Uhr schrieb Lars Ingebrigtsen <larsi <at> gnus.org>:
>
> Philipp Stephani <p.stephani2 <at> gmail.com> writes:
>
> >> Doing so seems easy enough, but I'm not sure how high our ambitions are
> >> for doing warning-free ELPA packages on older Emacs versions?  (I've
> >> added João to the CCs.)
> >
> > I think our ambitions should be quite high. (I personally think we
> > should treat almost all compiler warnings as errors/bugs and fix them
> > whenever realistically possible.)
>
> Building Emacs has traditionally been watching a wall of warnings scroll
> by.  This has recently changed, but shows that "no warnings" isn't a
> value held universally by the Emacs developers.
>
> I think that the Emacs build should be warning free -- on our main,
> current targets.  Jumping through hoops to avoid warnings on older Emacs
> versions normally isn't worth spending time on, in my opinion.

Yeah, but here we're talking about moving a single function definition
(eldoc--eval-expression-setup) around, which shouldn't realistically
cause problems.

>
> >> > 2. Probably eldoc should protect against newer Elisp functions being not
> >> >    yet available, as calling such functions will likely result in errors
> >> >    at runtime.
> >>
> >> Doesn't it do that?  What functions is it using that's not available?
> >
> > At least the current master version looks fine, though the byte
> > compiler isn't smart enough to detect that. The problematic uses are
> > in eldoc--eval-expression-setup.
>
> I'm not sure I follow you here -- are you saying that eldoc doesn't work
> on Emacs 26 because of the usages in `eldoc--eval-expression-setup'?

No, the code is correct as far as I can see. The functions that would
be unavailable in Emacs 26 won't be used in Emacs 26. But the byte
compiler detects only checks in the form of (when (fboundp 'FUNC)
(FUNC ...)) and similar, but not the check performed in that function.

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Philipp Stephani <p.stephani2 <at> gmail.com>
Cc: 42425 <at> debbugs.gnu.org,
 João Távora <joaotavora <at> gmail.com>
Subject: Re: bug#42425: 26.3.50; Compilation warnings when compiling
 eldoc.el under Emacs 26.3
Date: Tue, 26 Jan 2021 01:07:23 +0100

Philipp Stephani <p.stephani2 <at> gmail.com> writes:

>> I think that the Emacs build should be warning free -- on our main,
>> current targets.  Jumping through hoops to avoid warnings on older Emacs
>> versions normally isn't worth spending time on, in my opinion.
>
> Yeah, but here we're talking about moving a single function definition
> (eldoc--eval-expression-setup) around, which shouldn't realistically
> cause problems.

The most prominent warning was for `eldoc-documentation-strategy', which
is defined by

(eldoc--documentation-strategy-defcustom eldoc-documentation-strategy

so you then also have to move that, and

(defmacro eldoc--documentation-strategy-defcustom

and then slap and `eval-and-compile' around both (to make that warning
go away).

Which I had done before starting to think "but do we care?" and backed
out again.

>> I'm not sure I follow you here -- are you saying that eldoc doesn't work
>> on Emacs 26 because of the usages in `eldoc--eval-expression-setup'?
>
> No, the code is correct as far as I can see. The functions that would
> be unavailable in Emacs 26 won't be used in Emacs 26. But the byte
> compiler detects only checks in the form of (when (fboundp 'FUNC)
> (FUNC ...)) and similar, but not the check performed in that function.

Right, so it's also just a spurious warning.

I don't think we care this much about avoiding compilation warnings on
old Emacs versions, because it has the potential to make the code ugly
and awkward, and introduce a lot a churn that doesn't really help much.

So I'm closing this bug report.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Previous Next

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