* bug#69290: declare-function doesn't work when combined with --eval and -batch
@ 2024-02-20 18:59 Konstantin Kharlamov
2024-02-20 19:51 ` Eli Zaretskii
0 siblings, 1 reply; 9+ messages in thread
From: Konstantin Kharlamov @ 2024-02-20 18:59 UTC (permalink / raw)
To: 69290
Stumbled upon that while trying to improve CI in Evil mode. Enabling byte-compilation
causes warnings about `undo-redo` undeclared on older Emacs'es, so tried to work
around that with `declare-function`. Turns out it doesn't work.
# Steps to reproduce (in terms of terminal commands)
λ cat test.el
;;; -*- lexical-binding: t -*-
(hello)
λ emacs -batch --eval '(declare-function hello nil)' -f batch-byte-compile test.el
In end of data:
test.el:2:2: Warning: the function ‘hello’ is not known to be defined.
## Expected
There's no warning
## Actual
There's a warning about undeclared function which is declared
# Additional information
Versions tested:
* commit d4d5830f8a0 built 3 weeks ago from master.
* 27.1, 26.3, 25.3
^ permalink raw reply [flat|nested] 9+ messages in thread* bug#69290: declare-function doesn't work when combined with --eval and -batch 2024-02-20 18:59 bug#69290: declare-function doesn't work when combined with --eval and -batch Konstantin Kharlamov @ 2024-02-20 19:51 ` Eli Zaretskii 2024-02-20 19:56 ` Konstantin Kharlamov 0 siblings, 1 reply; 9+ messages in thread From: Eli Zaretskii @ 2024-02-20 19:51 UTC (permalink / raw) To: Konstantin Kharlamov; +Cc: 69290 > From: Konstantin Kharlamov <Hi-Angel@yandex.ru> > Date: Tue, 20 Feb 2024 21:59:31 +0300 > > Stumbled upon that while trying to improve CI in Evil mode. Enabling byte-compilation > causes warnings about `undo-redo` undeclared on older Emacs'es, so tried to work > around that with `declare-function`. Turns out it doesn't work. Of course it does. If used correctly, that is. We do that in gazillion places in our sources. > λ cat test.el > ;;; -*- lexical-binding: t -*- > (hello) > λ emacs -batch --eval '(declare-function hello nil)' -f batch-byte-compile test.el > > In end of data: > test.el:2:2: Warning: the function ‘hello’ is not known to be defined. > > ## Expected > > There's no warning What does the doc string of declare-function tell you about its usage and effect? ^ permalink raw reply [flat|nested] 9+ messages in thread
* bug#69290: declare-function doesn't work when combined with --eval and -batch 2024-02-20 19:51 ` Eli Zaretskii @ 2024-02-20 19:56 ` Konstantin Kharlamov 2024-02-20 20:03 ` Eli Zaretskii 0 siblings, 1 reply; 9+ messages in thread From: Konstantin Kharlamov @ 2024-02-20 19:56 UTC (permalink / raw) To: Eli Zaretskii; +Cc: 69290 On Tue, 2024-02-20 at 21:51 +0200, Eli Zaretskii wrote: > > From: Konstantin Kharlamov <Hi-Angel@yandex.ru> > > Date: Tue, 20 Feb 2024 21:59:31 +0300 > > > > Stumbled upon that while trying to improve CI in Evil mode. > > Enabling byte-compilation > > causes warnings about `undo-redo` undeclared on older Emacs'es, so > > tried to work > > around that with `declare-function`. Turns out it doesn't work. > > Of course it does. If used correctly, that is. We do that in > gazillion places in our sources. > > > λ cat test.el > > ;;; -*- lexical-binding: t -*- > > (hello) > > λ emacs -batch --eval '(declare-function hello nil)' -f batch- > > byte-compile test.el > > > > In end of data: > > test.el:2:2: Warning: the function ‘hello’ is not known to be > > defined. > > > > ## Expected > > > > There's no warning > > What does the doc string of declare-function tell you about its usage > and effect? It says `Tell the byte-compiler that function FN is defined, in FILE`, and then FILE may be nil. In the context of the problem it seems the only thing that's relevant. There's a lot more text, but the rest of it just explains behavior of different parameters. Is there anything I'm missing? ^ permalink raw reply [flat|nested] 9+ messages in thread
* bug#69290: declare-function doesn't work when combined with --eval and -batch 2024-02-20 19:56 ` Konstantin Kharlamov @ 2024-02-20 20:03 ` Eli Zaretskii 2024-02-20 20:13 ` Konstantin Kharlamov 0 siblings, 1 reply; 9+ messages in thread From: Eli Zaretskii @ 2024-02-20 20:03 UTC (permalink / raw) To: Konstantin Kharlamov; +Cc: 69290 > From: Konstantin Kharlamov <Hi-Angel@yandex.ru> > Cc: 69290@debbugs.gnu.org > Date: Tue, 20 Feb 2024 22:56:01 +0300 > > On Tue, 2024-02-20 at 21:51 +0200, Eli Zaretskii wrote: > > > λ emacs -batch --eval '(declare-function hello nil)' -f batch- > > > byte-compile test.el > > > > > > In end of data: > > > test.el:2:2: Warning: the function ‘hello’ is not known to be > > > defined. > > > > > > ## Expected > > > > > > There's no warning > > > > What does the doc string of declare-function tell you about its usage > > and effect? > > It says `Tell the byte-compiler that function FN is defined, in FILE`, > and then FILE may be nil. In the context of the problem it seems the > only thing that's relevant. There's a lot more text, but the rest of it > just explains behavior of different parameters. Is there anything I'm > missing? Does --eval '(declare-function hello nil)' tell anything to the byte-compiler? ^ permalink raw reply [flat|nested] 9+ messages in thread
* bug#69290: declare-function doesn't work when combined with --eval and -batch 2024-02-20 20:03 ` Eli Zaretskii @ 2024-02-20 20:13 ` Konstantin Kharlamov 2024-02-20 20:20 ` Eli Zaretskii 0 siblings, 1 reply; 9+ messages in thread From: Konstantin Kharlamov @ 2024-02-20 20:13 UTC (permalink / raw) To: Eli Zaretskii; +Cc: 69290 On Tue, 2024-02-20 at 22:03 +0200, Eli Zaretskii wrote: > > From: Konstantin Kharlamov <Hi-Angel@yandex.ru> > > Cc: 69290@debbugs.gnu.org > > Date: Tue, 20 Feb 2024 22:56:01 +0300 > > > > On Tue, 2024-02-20 at 21:51 +0200, Eli Zaretskii wrote: > > > > λ emacs -batch --eval '(declare-function hello nil)' -f > > > > batch- > > > > byte-compile test.el > > > > > > > > In end of data: > > > > test.el:2:2: Warning: the function ‘hello’ is not known to > > > > be > > > > defined. > > > > > > > > ## Expected > > > > > > > > There's no warning > > > > > > What does the doc string of declare-function tell you about its > > > usage > > > and effect? > > > > It says `Tell the byte-compiler that function FN is defined, in > > FILE`, > > and then FILE may be nil. In the context of the problem it seems > > the > > only thing that's relevant. There's a lot more text, but the rest > > of it > > just explains behavior of different parameters. Is there anything > > I'm > > missing? > > Does --eval '(declare-function hello nil)' tell anything to the > byte-compiler? Well, I can guess by the way you're asking that the answer is "no", but I have no idea why so. It should. It is the same as if you pop up Emacs, evaluate a (defun hello()) and then call `byte-compile-file` over the `test.el`. There won't be a warning, despite that `(defun hello ())` was never byte-compiled (AFAIK Emacs does note byte-compile evaluated code). ^ permalink raw reply [flat|nested] 9+ messages in thread
* bug#69290: declare-function doesn't work when combined with --eval and -batch 2024-02-20 20:13 ` Konstantin Kharlamov @ 2024-02-20 20:20 ` Eli Zaretskii 2024-02-20 20:31 ` Konstantin Kharlamov 0 siblings, 1 reply; 9+ messages in thread From: Eli Zaretskii @ 2024-02-20 20:20 UTC (permalink / raw) To: Konstantin Kharlamov; +Cc: 69290 > From: Konstantin Kharlamov <Hi-Angel@yandex.ru> > Cc: 69290@debbugs.gnu.org > Date: Tue, 20 Feb 2024 23:13:27 +0300 > > > Does --eval '(declare-function hello nil)' tell anything to the > > byte-compiler? > > Well, I can guess by the way you're asking that the answer is "no", but > I have no idea why so. It should. How can it? The declare-function form is evaluated by the startup code, and only after that the byte-compiler is invoked to compile test.el. At least this is my analysis of what happens here. > It is the same as if you pop up Emacs, evaluate a (defun hello()) > and then call `byte-compile-file` over the `test.el`. There won't be > a warning, despite that `(defun hello ())` was never byte-compiled > (AFAIK Emacs does note byte-compile evaluated code). For the declare-function form to take effect, the byte-compiler needs to evaluate the form. By contrast, defun is evaluated by the Lisp interpreter and the result is stored in the global state. ^ permalink raw reply [flat|nested] 9+ messages in thread
* bug#69290: declare-function doesn't work when combined with --eval and -batch 2024-02-20 20:20 ` Eli Zaretskii @ 2024-02-20 20:31 ` Konstantin Kharlamov 2024-02-20 21:28 ` Konstantin Kharlamov 0 siblings, 1 reply; 9+ messages in thread From: Konstantin Kharlamov @ 2024-02-20 20:31 UTC (permalink / raw) To: Eli Zaretskii; +Cc: 69290 On Tue, 2024-02-20 at 22:20 +0200, Eli Zaretskii wrote: > > From: Konstantin Kharlamov <Hi-Angel@yandex.ru> > > Cc: 69290@debbugs.gnu.org > > Date: Tue, 20 Feb 2024 23:13:27 +0300 > > > > > Does --eval '(declare-function hello nil)' tell anything to the > > > byte-compiler? > > > > Well, I can guess by the way you're asking that the answer is "no", > > but > > I have no idea why so. It should. > > How can it? The declare-function form is evaluated by the startup > code, and only after that the byte-compiler is invoked to compile > test.el. At least this is my analysis of what happens here. > > > It is the same as if you pop up Emacs, evaluate a (defun hello()) > > and then call `byte-compile-file` over the `test.el`. There won't > > be > > a warning, despite that `(defun hello ())` was never byte-compiled > > (AFAIK Emacs does note byte-compile evaluated code). > > For the declare-function form to take effect, the byte-compiler needs > to evaluate the form. By contrast, defun is evaluated by the Lisp > interpreter and the result is stored in the global state. Oh, thank you for explanation, I see. It's doesn't seem to be obvious to a bystander, because from the side it seems like in Emacs byte- compiler and interpreter should work in a tandem, as in the example with evaluating (defun hello()). In Emacs context the doc-string that says `Tell the byte-compiler that function FN is defined` would read to me as "modify global state, which later will be read by byte-compiler to deem FN as defined". IOW, to me as a bystander the documentation string does not explain the difference, which is why we just had this somewhat long discussion before I understood why `declare-function` works this way. I guess the bug can be closed, sorry for the noise. ^ permalink raw reply [flat|nested] 9+ messages in thread
* bug#69290: declare-function doesn't work when combined with --eval and -batch 2024-02-20 20:31 ` Konstantin Kharlamov @ 2024-02-20 21:28 ` Konstantin Kharlamov 2024-02-21 3:30 ` Eli Zaretskii 0 siblings, 1 reply; 9+ messages in thread From: Konstantin Kharlamov @ 2024-02-20 21:28 UTC (permalink / raw) To: Eli Zaretskii; +Cc: 69290 On Tue, 2024-02-20 at 23:31 +0300, Konstantin Kharlamov wrote: > On Tue, 2024-02-20 at 22:20 +0200, Eli Zaretskii wrote: > > > From: Konstantin Kharlamov <Hi-Angel@yandex.ru> > > > Cc: 69290@debbugs.gnu.org > > > Date: Tue, 20 Feb 2024 23:13:27 +0300 > > > > > > > Does --eval '(declare-function hello nil)' tell anything to the > > > > byte-compiler? > > > > > > Well, I can guess by the way you're asking that the answer is > > > "no", > > > but > > > I have no idea why so. It should. > > > > How can it? The declare-function form is evaluated by the startup > > code, and only after that the byte-compiler is invoked to compile > > test.el. At least this is my analysis of what happens here. > > > > > It is the same as if you pop up Emacs, evaluate a (defun hello()) > > > and then call `byte-compile-file` over the `test.el`. There won't > > > be > > > a warning, despite that `(defun hello ())` was never byte- > > > compiled > > > (AFAIK Emacs does note byte-compile evaluated code). > > > > For the declare-function form to take effect, the byte-compiler > > needs > > to evaluate the form. By contrast, defun is evaluated by the Lisp > > interpreter and the result is stored in the global state. > > Oh, thank you for explanation, I see. It's doesn't seem to be obvious > to a bystander, because from the side it seems like in Emacs byte- > compiler and interpreter should work in a tandem, as in the example > with evaluating (defun hello()). In Emacs context the doc-string that > says `Tell the byte-compiler that function FN is defined` would read > to > me as "modify global state, which later will be read by byte-compiler > to deem FN as defined". IOW, to me as a bystander the documentation > string does not explain the difference, which is why we just had this > somewhat long discussion before I understood why `declare-function` > works this way. Btw, I just figured out how to show you why this doc-string doesn't say anything on the matter. Imagine for a second that `declare-function` is getting through from "eval" to the byte-compiler, i.e. the problem we're discussing is just not present. Would you change the string `Tell the byte-compiler that function FN is defined` to something else in this case? I would not, because it's still byte-compiler that does all the checking, so the point that "declare-function" is purposed for `byte-compiler` stands. ^ permalink raw reply [flat|nested] 9+ messages in thread
* bug#69290: declare-function doesn't work when combined with --eval and -batch 2024-02-20 21:28 ` Konstantin Kharlamov @ 2024-02-21 3:30 ` Eli Zaretskii 0 siblings, 0 replies; 9+ messages in thread From: Eli Zaretskii @ 2024-02-21 3:30 UTC (permalink / raw) To: Konstantin Kharlamov, Stefan Monnier; +Cc: 69290 > From: Konstantin Kharlamov <Hi-Angel@yandex.ru> > Cc: 69290@debbugs.gnu.org > Date: Wed, 21 Feb 2024 00:28:46 +0300 > > On Tue, 2024-02-20 at 23:31 +0300, Konstantin Kharlamov wrote: > > On Tue, 2024-02-20 at 22:20 +0200, Eli Zaretskii wrote: > > > > From: Konstantin Kharlamov <Hi-Angel@yandex.ru> > > > > Cc: 69290@debbugs.gnu.org > > > > Date: Tue, 20 Feb 2024 23:13:27 +0300 > > > > > > > > > Does --eval '(declare-function hello nil)' tell anything to the > > > > > byte-compiler? > > > > > > > > Well, I can guess by the way you're asking that the answer is > > > > "no", > > > > but > > > > I have no idea why so. It should. > > > > > > How can it? The declare-function form is evaluated by the startup > > > code, and only after that the byte-compiler is invoked to compile > > > test.el. At least this is my analysis of what happens here. > > > > > > > It is the same as if you pop up Emacs, evaluate a (defun hello()) > > > > and then call `byte-compile-file` over the `test.el`. There won't > > > > be > > > > a warning, despite that `(defun hello ())` was never byte- > > > > compiled > > > > (AFAIK Emacs does note byte-compile evaluated code). > > > > > > For the declare-function form to take effect, the byte-compiler > > > needs > > > to evaluate the form. By contrast, defun is evaluated by the Lisp > > > interpreter and the result is stored in the global state. > > > > Oh, thank you for explanation, I see. It's doesn't seem to be obvious > > to a bystander, because from the side it seems like in Emacs byte- > > compiler and interpreter should work in a tandem, as in the example > > with evaluating (defun hello()). In Emacs context the doc-string that > > says `Tell the byte-compiler that function FN is defined` would read > > to > > me as "modify global state, which later will be read by byte-compiler > > to deem FN as defined". IOW, to me as a bystander the documentation > > string does not explain the difference, which is why we just had this > > somewhat long discussion before I understood why `declare-function` > > works this way. > > Btw, I just figured out how to show you why this doc-string doesn't say > anything on the matter. Imagine for a second that `declare-function` is > getting through from "eval" to the byte-compiler, i.e. the problem > we're discussing is just not present. Would you change the string `Tell > the byte-compiler that function FN is defined` to something else in > this case? I would not, because it's still byte-compiler that does all > the checking, so the point that "declare-function" is purposed for > `byte-compiler` stands. Stefan, any comments or suggestion for how best to document this (if I'm right)? ^ permalink raw reply [flat|nested] 9+ messages in thread
end of thread, other threads:[~2024-02-21 3:30 UTC | newest] Thread overview: 9+ messages (download: mbox.gz / follow: Atom feed) -- links below jump to the message on this page -- 2024-02-20 18:59 bug#69290: declare-function doesn't work when combined with --eval and -batch Konstantin Kharlamov 2024-02-20 19:51 ` Eli Zaretskii 2024-02-20 19:56 ` Konstantin Kharlamov 2024-02-20 20:03 ` Eli Zaretskii 2024-02-20 20:13 ` Konstantin Kharlamov 2024-02-20 20:20 ` Eli Zaretskii 2024-02-20 20:31 ` Konstantin Kharlamov 2024-02-20 21:28 ` Konstantin Kharlamov 2024-02-21 3:30 ` Eli Zaretskii
Code repositories for project(s) associated with this public inbox https://git.savannah.gnu.org/cgit/emacs.git This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).