From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: =?UTF-8?Q?K=C3=A9vin?= Le Gouguec Newsgroups: gmane.emacs.bugs Subject: bug#60366: [PATCH] Simplify introduction of use-package manual Date: Tue, 27 Dec 2022 22:43:49 +0100 Message-ID: <87v8lwed4a.fsf@gmail.com> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="32975"; mail-complaints-to="usenet@ciao.gmane.io" To: 60366@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Tue Dec 27 22:44:23 2022 Return-path: Envelope-to: geb-bug-gnu-emacs@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 1pAHkF-0008QG-FO for geb-bug-gnu-emacs@m.gmane-mx.org; Tue, 27 Dec 2022 22:44:23 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pAHjx-0004N3-VM; Tue, 27 Dec 2022 16:44:05 -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 1pAHjv-0004Mj-6q for bug-gnu-emacs@gnu.org; Tue, 27 Dec 2022 16:44:03 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pAHju-00079m-Kc for bug-gnu-emacs@gnu.org; Tue, 27 Dec 2022 16:44:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pAHju-0008Jm-GN for bug-gnu-emacs@gnu.org; Tue, 27 Dec 2022 16:44:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: =?UTF-8?Q?K=C3=A9vin?= Le Gouguec Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 27 Dec 2022 21:44:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 60366 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.167217743031946 (code B ref -1); Tue, 27 Dec 2022 21:44:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 27 Dec 2022 21:43:50 +0000 Original-Received: from localhost ([127.0.0.1]:56642 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pAHjh-0008JC-Ou for submit@debbugs.gnu.org; Tue, 27 Dec 2022 16:43:50 -0500 Original-Received: from lists.gnu.org ([209.51.188.17]:37360) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pAHjg-0008J5-Gj for submit@debbugs.gnu.org; Tue, 27 Dec 2022 16:43:48 -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 1pAHjg-0004Lc-CC for bug-gnu-emacs@gnu.org; Tue, 27 Dec 2022 16:43:48 -0500 Original-Received: from mail-wm1-x336.google.com ([2a00:1450:4864:20::336]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pAHje-00078b-1f for bug-gnu-emacs@gnu.org; Tue, 27 Dec 2022 16:43:48 -0500 Original-Received: by mail-wm1-x336.google.com with SMTP id ay2-20020a05600c1e0200b003d22e3e796dso10212042wmb.0 for ; Tue, 27 Dec 2022 13:43:45 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=mime-version:message-id:date:subject:to:from:from:to:cc:subject :date:message-id:reply-to; bh=UIPrkzKFu/U3OsZoy2VtKAz5mZKhZQj2kxphtKMGQvI=; b=F7y4qjcTdtvmRjjE5b4N4hZGi3yhPL9zy2sD5RWmSf73goEZPelh+PTlEdZIP/4oJM r9zhDTkgwKYIvsg/ui7aJWYyiZgFCaDyIM7Y2gowRz/jxXdJ3HiaaVN8IQI7926putpa sqZry2DZ9lUF67UhLU0fZkHqdZEhivbqr7eRDWgRbbQ4YG3rMNeKFGVchGz//ZAyVc/H aQiXSk567v3DFriKYtOUtcfxMyGyaJZ/Fa6GRwzebSLx5kneAZQzVWDY+2iOA+7l4ckT QpOHlVgmP/Lv28LxsmlKKHxyXziHvuYYImWkX1NqcipiSJJOP0cLFqJJyI/Smc1FrFGC idjQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=mime-version:message-id:date:subject:to:from:x-gm-message-state :from:to:cc:subject:date:message-id:reply-to; bh=UIPrkzKFu/U3OsZoy2VtKAz5mZKhZQj2kxphtKMGQvI=; b=CVKZUmH9krV7vsZ98/0YsKfHwrA3T7Z+oiO1O2uXhYCLiIaOMF8haWmCwJeRIlJNiS 3n0Bic9wW1OhwDcI6or1ygaBzwC18c5xEQ/y91b2+OsYhT5pOi7w6bnuCk/D52RRU4kI GVy3/r6xbHZ5qb/QYUD2ld1XRkx2wiF19x+6m99OaNAKjLZDL/HbWzel63dIWJqFKQRx 5d0Xo8xR67/47WxdErjjgoCvqzKHdFMZhepNMahaFL+cS+uFPMryZvi1fru6ZK4nVAJU BVuaBGuvXFgNA+TfRGynUBnm7MYDnC7bTokxPWZ2VeGOc0veo8HJbtJYYdSgUa1pT0kr 3NmA== X-Gm-Message-State: AFqh2kpVjPEgrPTps+S5AKLiNKpiv7bsCu5/IF2qO3bnDugZpN4m+98g H7/Uj3S8Tg0Dnl21Csqhl3cmRGR6dKI= X-Google-Smtp-Source: AMrXdXsT16/3HsaOMopm4vj9JNSPjDlRPbWmdCmEH55+Fw8fnzHF7vmzr5Zqlg+7x8zcA40Y6NKYJg== X-Received: by 2002:a05:600c:1ca5:b0:3d1:d746:7bca with SMTP id k37-20020a05600c1ca500b003d1d7467bcamr16272194wms.4.1672177423861; Tue, 27 Dec 2022 13:43:43 -0800 (PST) Original-Received: from hirondell ([2001:861:38ca:5f70:7347:9ec1:df7c:18ef]) by smtp.gmail.com with ESMTPSA id r9-20020a05600c35c900b003d96bdddd3dsm19019978wmq.15.2022.12.27.13.43.42 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 27 Dec 2022 13:43:42 -0800 (PST) Received-SPF: pass client-ip=2a00:1450:4864:20::336; envelope-from=kevin.legouguec@gmail.com; helo=mail-wm1-x336.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:251968 Archived-At: --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Tags: patch Hello Emacs, A couple of things intrigue me in the current introduction of the use-package manual: > This chapter provides instructions and examples for quickly getting > started with use-package. The first thing you need to do is make sure > that =E2=80=98use-package=E2=80=99 itself is loaded. To do that, put thi= s at the top of > your init file: >=20 > (require 'use-package) >=20 > The above makes the =E2=80=98use-macro=E2=80=99 available for us in th= e rest of your > init file. In this manual, we say that each call to =E2=80=98use-macro= =E2=80=99 is a > =E2=80=9Cdeclaration=E2=80=9D, to highlight the declarative nature of its= syntax. =E2=80=94 (info "(use-package) Getting Started") (a) I don't think use-package defines anything called "use-macro"; guessing this was supposed to read "=E2=80=98use-package=E2=80=99 macro" in= stead? I guess the former could be a shorthand for the latter, but it's not used anywhere else in the manual. (b) AFAICT use-package is autoloaded, so there should be no need for the user to (require 'use-package)? I've made a patch against emacs-29 to simplify this part of the manual according to these hypotheses. I hope they are correct; apologies for the noise if not. (And even if the hypotheses are correct, I hope the patch is OK: the second sentence in this tentative new paragraph feels a bit disconnected from the first to me. Still, I figured it was worth submitting anyway just to validate those hypotheses before racking more of my brain on optimal wording) Thanks. In GNU Emacs 30.0.50 (build 1, x86_64-pc-linux-gnu, GTK+ Version 3.24.24, cairo version 1.16.0) of 2022-12-26 built on hirondell Repository revision: 2ffe1494e16381cfc7fec95a6a0879f268df3e95 Repository branch: master Windowing system distributor 'The X.Org Foundation', version 11.0.12011000 System Description: Debian GNU/Linux 11 (bullseye) Configured using: 'configure --cache-file=3D/home/peniblec/.cache/emacs/config,src,emacs --with-cairo --with-gconf --with-sqlite3 --with-xinput2' --=-=-= Content-Type: text/patch Content-Disposition: attachment; filename=0001-Simplify-introduction-of-use-package-manual.patch >From 15b50490cb87b19888dcb95b84a78d05686e7b89 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20Le=20Gouguec?= Date: Tue, 27 Dec 2022 15:40:43 +0100 Subject: [PATCH] Simplify introduction of use-package manual * doc/misc/use-package.texi (Getting Started): Do not advise requiring the package, since the macro is autoloaded; also correct the macro's name. --- doc/misc/use-package.texi | 16 +++------------- 1 file changed, 3 insertions(+), 13 deletions(-) diff --git a/doc/misc/use-package.texi b/doc/misc/use-package.texi index c587d23d74b..1d0e38a1eca 100644 --- a/doc/misc/use-package.texi +++ b/doc/misc/use-package.texi @@ -132,19 +132,9 @@ Getting Started @cindex quick-start instructions This chapter provides instructions and examples for quickly getting -started with use-package. The first thing you need to do is make sure -that @file{use-package} itself is loaded. To do that, put this at the -top of your init file: - -@lisp -(require 'use-package) -@end lisp - -@cindex declaration -The above makes the @code{use-macro} available for us in the rest of -your init file. In this manual, we say that each call to -@code{use-macro} is a @dfn{declaration}, to highlight the declarative -nature of its syntax. +started with use-package. In this manual, we say that each call to +the @code{use-package} macro in your init file is a @dfn{declaration}, +to highlight the declarative nature of its syntax. To unconditionally load a package named @samp{foo}, add the following declaration to your init file: -- 2.30.2 --=-=-=--