emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

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


From: Jean-Christophe Helary
Subject: Re: "Emacs Lisp Packages" chapter in the Emacs manual
Date: Sun, 10 May 2020 11:19:47 +0900

> On May 10, 2020, at 1:47, Jean-Christophe Helary <address@hidden> wrote:
> 
>> On May 10, 2020, at 0:19, Stefan Kangas <address@hidden> wrote:
>> 
>> Jean-Christophe Helary <address@hidden>
>> writes:
>> 
>>> --- a/doc/emacs/package.texi
>>> +++ b/doc/emacs/package.texi
>>> @@ -13,6 +13,9 @@ Packages
>>> separate Emacs Lisp program, sometimes including other components such
>>> as an Info manual.
>>> 
>>> +  Emacs Lisp programs that are not available through this facility can
>>> +still be loaded by installing them in the Emacs Lisp @dfn{load path}.  
>>> @xref{Lisp Libraries}.
>>> +
>>>>  @kbd{M-x list-packages} brings up a buffer named @file{*Packages*}
>>> with a list of all packages.  You can install or uninstall packages
>>> via this buffer.  @xref{Package Menu}.
>> 
>> It's a useful addition, I think, but it seems a bit backwards to add it
>> before even introducing `list-packages'.
>> 
>> I would suggest to move it further down.  It could be the second to last
>> paragraph, for example.
> 
> I'm not the most qualified person to discuss location, but if people think 
> "install", it seems nice to tell them up front that there are 2 ways to do 
> that. 
> 
> In fact, I first thought of something like this:
> 
> ============
> The traditional way to install Emacs Lisp code is to install it in the Emacs 
> Lisp @dfn{load path}.  @xref{Lisp Libraries}.
> 
> Now, Emacs includes a facility that lets you easily download and install
> @dfn{packages} that implement additional features.
> ...
> ============


I think I have a better proposal:

1) add a pointer to the Lisp Librairies section of the manual in package.texi

48 Emacs Lisp Packages
**********************

The traditional way to install Emacs Lisp code is to install it in the
Emacs Lisp "load path".  *Note Lisp Libraries::.

   Now, Emacs includes a facility that lets you easily download and
install "packages" that implement additional features.  Each package is
a separate Emacs Lisp program, sometimes including other components such
as an Info manual.


2) add a reference to "require" in the Features section of the manual in 
building.texi

   To automatically load code that you have installed in the load path,
you can use `require' in your init file.  *Note Features:
(elisp)Features. For example, here's how to automatically load the
features provided by file `feature.el' installed in your load path:

     (require 'feature)


Is there a better way to give easy access to this information ? In case the 
proposal above is accepted, I'm attaching the corresponding patch.


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


Attachment: package.texi.200510.diff
Description: Binary data


reply via email to

[Prev in Thread] Current Thread [Next in Thread]