From: Eli Zaretskii <eliz@gnu.org>
To: rms@gnu.org
Cc: emacs-devel@gnu.org
Subject: Re: use-package documentation
Date: Sun, 01 Jan 2023 08:46:12 +0200 [thread overview]
Message-ID: <835ydq4urv.fsf@gnu.org> (raw)
In-Reply-To: <E1pBoe7-0004rn-C9@fencepost.gnu.org> (message from Richard Stallman on Sat, 31 Dec 2022 22:04:23 -0500)
> 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.
next prev parent reply other threads:[~2023-01-01 6:46 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-12-30 4:03 use-package documentation Richard Stallman
2022-12-30 9:01 ` Eli Zaretskii
2022-12-31 11:28 ` Stefan Kangas
2023-01-01 8:39 ` Eli Zaretskii
2023-01-01 3:04 ` Richard Stallman
2023-01-01 6:46 ` Eli Zaretskii [this message]
2023-01-04 19:23 ` John Wiegley
2023-01-05 10:36 ` Stefan Kangas
2023-01-05 11:19 ` Eli Zaretskii
2023-01-06 4:37 ` Richard Stallman
2023-01-06 7:13 ` Eli Zaretskii
2022-12-30 9:02 ` Philip Kaludercic
2023-01-06 6:03 ` David Masterson
2023-01-06 7:06 ` Ihor Radchenko
2023-01-06 7:43 ` Eli Zaretskii
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=835ydq4urv.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=rms@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).