* Re: [Emacs-diffs] emacs-26 97b0e41: Improve documentation of safe values of variables
[not found] ` <20180113104925.A73312044D@vcs0.savannah.gnu.org>
@ 2018-01-13 22:08 ` Stefan Monnier
2018-01-14 16:49 ` Eli Zaretskii
0 siblings, 1 reply; 2+ messages in thread
From: Stefan Monnier @ 2018-01-13 22:08 UTC (permalink / raw)
To: emacs-devel; +Cc: Eli Zaretskii
> +Definitions}). However, a safety predicate defined using @code{:safe}
> +will only be known once the byte-compiler is loaded.
[ That was the case for byte-compile-error-on-warn, but that's only
because it's defined in the byte-compiler, so I changed this to say
"the package that contains the defcustom". ]
> +@noindent
> +The safe value definitions specified with @code{autoload} are copied
> +into the @file{loaddefs.el} file, and are known to Emacs since the
> +beginning of a session.
I'm not sure how to improve this description, but for the many readers
who are not hacking on Emacs's bundled files this is misleading:
e.g. for an ELPA package, the autoload will not go into loaddefs.el but
into <pkg>-autoloads.el. And for non-packaged files, the autoload
cookie will even likely be ignored because the user won't know how to
create&update&use an autoloads file.
Stefan
^ permalink raw reply [flat|nested] 2+ messages in thread* Re: [Emacs-diffs] emacs-26 97b0e41: Improve documentation of safe values of variables
2018-01-13 22:08 ` [Emacs-diffs] emacs-26 97b0e41: Improve documentation of safe values of variables Stefan Monnier
@ 2018-01-14 16:49 ` Eli Zaretskii
0 siblings, 0 replies; 2+ messages in thread
From: Eli Zaretskii @ 2018-01-14 16:49 UTC (permalink / raw)
To: Stefan Monnier; +Cc: emacs-devel
> From: Stefan Monnier <monnier@IRO.UMontreal.CA>
> Cc: Eli Zaretskii <eliz@gnu.org>
> Date: Sat, 13 Jan 2018 17:08:29 -0500
>
> > +Definitions}). However, a safety predicate defined using @code{:safe}
> > +will only be known once the byte-compiler is loaded.
>
> [ That was the case for byte-compile-error-on-warn, but that's only
> because it's defined in the byte-compiler, so I changed this to say
> "the package that contains the defcustom". ]
Thanks.
> > +@noindent
> > +The safe value definitions specified with @code{autoload} are copied
> > +into the @file{loaddefs.el} file, and are known to Emacs since the
> > +beginning of a session.
>
> I'm not sure how to improve this description, but for the many readers
> who are not hacking on Emacs's bundled files this is misleading:
> e.g. for an ELPA package, the autoload will not go into loaddefs.el but
> into <pkg>-autoloads.el. And for non-packaged files, the autoload
> cookie will even likely be ignored because the user won't know how to
> create&update&use an autoloads file.
I tried to improve the wording with a follow-up change.
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2018-01-14 16:49 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
[not found] <20180113104924.23187.97574@vcs0.savannah.gnu.org>
[not found] ` <20180113104925.A73312044D@vcs0.savannah.gnu.org>
2018-01-13 22:08 ` [Emacs-diffs] emacs-26 97b0e41: Improve documentation of safe values of variables Stefan Monnier
2018-01-14 16:49 ` 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).