From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.devel Subject: Re: use-package documentation Date: Sun, 01 Jan 2023 08:46:12 +0200 Message-ID: <835ydq4urv.fsf@gnu.org> References: <83bknl6zan.fsf@gnu.org> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="25007"; mail-complaints-to="usenet@ciao.gmane.io" Cc: emacs-devel@gnu.org To: rms@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sun Jan 01 07:47:02 2023 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1pBs7Z-0006Hz-BV for ged-emacs-devel@m.gmane-mx.org; Sun, 01 Jan 2023 07:47:01 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pBs6v-0003xL-S0; Sun, 01 Jan 2023 01:46:21 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pBs6s-0003x3-BU for emacs-devel@gnu.org; Sun, 01 Jan 2023 01:46:19 -0500 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pBs6q-00033j-Oa for emacs-devel@gnu.org; Sun, 01 Jan 2023 01:46:17 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=2wTxH413p/NVKvSZjIKgYW8vN6vbI3MKTZTX1dC9l6s=; b=eR3ylnP6HIU9 s2rmOaS4hh7L3l3JnA8/TW1iTbUHToBPwm42/Bsv8k7G9+kqEP/5hdEezc+aJYhq0uM3jazAxkeDR P1LBNjyo5/XMc3/00JAiXjdKNY+H6ELFsmkVVh2g97D9I87fhWQFZghy1D+DSYm5yWZGklsQRDmaa 0RaM5EBY8/NRIQr6fUax+wLSqSR294nZe5XEym2NNyWBY0gL5vmDvqJqPU4kAKKsWrPpCGnlMsuSN hS4/P49cwF5Arq9Rf2GvkVNRx3FCeOh1eobUbAnmAnzsv1Y1VO6hZXUbNSXfy6tveX7Uy/H9AK0M3 E65cgAAXANIzUwUuLYn2Og==; Original-Received: from [87.69.77.57] (helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pBs6i-0005UZ-0m; Sun, 01 Jan 2023 01:46:08 -0500 In-Reply-To: (message from Richard Stallman on Sat, 31 Dec 2022 22:04:23 -0500) X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.devel:302178 Archived-At: > From: Richard Stallman > 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.