[Top][All Lists]

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

Re: use-package documentation

From: Eli Zaretskii
Subject: Re: use-package documentation
Date: Sun, 01 Jan 2023 08:46:12 +0200

> From: Richard Stallman <rms@gnu.org>
> Cc: emacs-devel@gnu.org
> Date: Sat, 31 Dec 2022 22:04:23 -0500
>   > It is a relatively large manual (2K lines of Texinfo), so adding it is
>   > somewhat problematic.  It is also half-way between user-level and
>   > Lisp-level, so which manual should mention it is not clear.
> People expect the Emacs Lisp Reference Manual to tell all about Emacs
> Lisp except for things that are somewhat obscure.  People have said
> that use-package is much more convenient than `require' for the .emacs
> file.  If that is so, we can expect it to become widely used if we
> make the community aware of it.
> This argues that at least the most important/most widely used features
> of `use-package' should be described in the Emacs Lisp Reference
> Manual.  The rest of the could be left in a separate manual.

That is already a lot, AFAICT.  use-package's features are generally
present only if they are very useful.

And I don't really understand the urge to have it in the ELisp manual:
a cross-reference to another manual is as easy to follow as a
cross-reference to another node within the same manual.  In many cases
the reader will not even be aware he or she is reading a different
manual.  So what problem do we want to solve by placing the
use-package stuff in the ELisp manual?

> Where in the Emacs Lisp Reference Manual should those aspects of
> `use-package' go?  Perhaps in the node, The Init File.  Or in a new
> node, added just after that one, to contain "useful things to use in
> your init file".

If it's just a short mention, probably in The Init File.  But I also
wanted to mention it in the Emacs User manual, where we describe some
simple customizations, and give a couple of examples there.

reply via email to

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