Re: [Emacs-diffs] emacs-26 97b0e41: Improve documentation of safe values of variables

Re: [Emacs-diffs] emacs-26 97b0e41: Improve documentation of safe values of variables

[Stefan Monnier]

> +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

Re: [Emacs-diffs] emacs-26 97b0e41: Improve documentation of safe values of variables

[Eli Zaretskii]

> 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.