Re: "Emacs Lisp Packages" chapter in the Emacs manual

[Jean-Christophe Helary <jean.christophe.helary@traduction-libre.org>]

[-- Attachment #1: Type: text/plain, Size: 1808 bytes --]



> On May 12, 2020, at 12:21, Stefan Monnier <monnier@iro.umontreal.ca> wrote:
> 
>>> [ The first step is of course to make sure the file is found from
>>> `load-path`.  ]
>> 
>> Like ask the user to manually do M-x load-library and see the result ?
> 
> Traditionally it was done either by telling the user to
> 
>    put this file somewhere in your `load-path`
> 
> or to
> 
>    (add-to-list 'load-path "/where/ever/you/put/that/file/")

Excellent :)

>> Well, actually all this started because I wanted to install Drew's
>> help-fns+.el and it happens that Drew uses "require".
> 
> Then follow Drew's suggestion, since that's how he designed his library.
> 
>> So, in case I want to add a similar feature set, would 'require be too much ?
> 
> I know nothing about help-fns+ so I can't answer that.
> But nowadays libraries should be designed for the case where they're
> installed by a tool like package.el and in such a case, the user should
> almost never need to `require` the package.
> 
>> Would (autoload 'help-fns+) be sufficient ?
> 
> `autoload` takes 2 args, the first being a function name and the second
> the file in which that function is to be found.
> 
>> Keep in mind that this addition is for users who know a minimal subset of
>> Emacs lisp (enough to play with their init file), not for authors.
> 
> Those users should *never* need to do that: either they install via
> something like package.el

Which is already covered in the manual, so there is no need to consider that case.

> or they follow steps in the package's installation instructions.

Ok, I guess that's the information I was looking for :)

Jean-Christophe Helary
-----------------------------------------------
http://mac4translators.blogspot.com @brandelune



[-- Attachment #2: package.texi.200512.diff --]
[-- Type: application/octet-stream, Size: 1422 bytes --]

diff --git a/doc/emacs/building.texi b/doc/emacs/building.texi
index 77a0e807c2..79cedb59a5 100644
--- a/doc/emacs/building.texi
+++ b/doc/emacs/building.texi
@@ -1558,7 +1558,7 @@ Lisp Libraries
 @code{help-enable-autoload} to @code{nil}.
 
 @vindex help-enable-completion-autoload
-Automatic loading also occurs when completing names for
+  Automatic loading also occurs when completing names for
 @code{describe-variable} and @code{describe-function}, based on the
 prefix being completed.  To disable this feature, change the variable
 @code{help-enable-completion-autoload} to @code{nil}.
diff --git a/doc/emacs/package.texi b/doc/emacs/package.texi
index db3cf317ff..aa7c7e35bb 100644
--- a/doc/emacs/package.texi
+++ b/doc/emacs/package.texi
@@ -7,8 +7,12 @@ Packages
 @cindex Package
 @cindex Emacs Lisp package archive
 @cindex Package archive
+The traditional way to install Emacs Lisp code is to either install it
+in the Emacs Lisp @dfn{load path} or to add the path to the code to
+the load path list.  @xref{Lisp Libraries}. Then, the user should
+follow the instructions given by the code author.
 
-Emacs includes a facility that lets you easily download and install
+  Now, Emacs includes a facility that lets you easily download and install
 @dfn{packages} that implement additional features.  Each package is a
 separate Emacs Lisp program, sometimes including other components such
 as an Info manual.