From unknown Sun Jun 22 17:15:40 2025 X-Loop: help-debbugs@gnu.org Subject: bug#60366: [PATCH] Simplify introduction of use-package manual 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 To: 60366@debbugs.gnu.org X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Received: via spool by submit@debbugs.gnu.org id=B.167217743031946 (code B ref -1); Tue, 27 Dec 2022 21:44:02 +0000 Received: (at submit) by debbugs.gnu.org; 27 Dec 2022 21:43:50 +0000 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 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 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 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 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) 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) From: =?UTF-8?Q?K=C3=A9vin?= Le Gouguec Date: Tue, 27 Dec 2022 22:43:49 +0100 Message-ID: <87v8lwed4a.fsf@gmail.com> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" 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-Spam-Score: -1.3 (-) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -2.3 (--) --=-=-= 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 --=-=-=-- From debbugs-submit-bounces@debbugs.gnu.org Thu Dec 29 13:36:45 2022 Received: (at control) by debbugs.gnu.org; 29 Dec 2022 18:36:45 +0000 Received: from localhost ([127.0.0.1]:32843 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pAxll-0007yT-4U for submit@debbugs.gnu.org; Thu, 29 Dec 2022 13:36:45 -0500 Received: from mail-wr1-f45.google.com ([209.85.221.45]:43731) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pAxlj-0007yG-9A for control@debbugs.gnu.org; Thu, 29 Dec 2022 13:36:43 -0500 Received: by mail-wr1-f45.google.com with SMTP id z10so18029171wrh.10 for ; Thu, 29 Dec 2022 10:36:43 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:subject:from:to:message-id :date:from:to:cc:subject:date:message-id:reply-to; bh=RzigL9H6TdyHXPCMMdAfOMtLELrYBMCXg7hZNPk85CY=; b=qxlCf6rbuM4J2tnkIPSO5ylH+qMjlM98ZClr0T2c7H3u/roAOdX2ZGyUvOMSnHJYdR kW4WFUKQJQJYsc2kZ+jOOYXiEkQ1xBzdsNwA+xpi6gRo93UffwwXrj0bOTb+3AUoCA6X w52CEZFmG34XT0NliUANowfiNUsX1FayW5/9x6+V7Ah/OMYpv3yq6WrtetiICYEFbu8v Oc+f56/4Y7d5NlEM3r/283kvmNiw2K1YeVSJLFVjCB87t0Pf9w9IUzOsMIgUyLwMkUsL p0kaBHb/a3BNe5J1ULhWiBC8mdHu+9zbTU5HUhEKRqmbNQN7J39rxl4YUcpDrcP4iuoD Bl9g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:subject:from:to:message-id :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=RzigL9H6TdyHXPCMMdAfOMtLELrYBMCXg7hZNPk85CY=; b=o1m1Udzluec+akyZe+Q3U2Vl3R+eh80Lh8phjYzUuRhJmIf42AWAK163Ef5QmP+gO0 fT4UbDLrNjEOKXU3uWsNgDWHeFQ+89rspLa5OYKKjsdPjiuVVoTrRNVblDN+n2PnUXTR LV4FOrEJt5Q188xExZkeZlOSeP76NvUIdjSXMPrdjGtpXFG4WZ6fjqoFMwZ/7x7HhviT +50Lg26B/6Ziq5hSVhpMaqxg0XeJ9gZlQNHw5r/gQh1lpekAdsfND390z88/AOJGEB0e VIUwKRhJzp61uHnPW0jAfmrg69TXyIWWaY8Y0tZ7qRQOKQeJQ5/e3wVWAUy9mN2YzE4Y pFbQ== X-Gm-Message-State: AFqh2krZoSEPAgZ08RMUyuH3KYpHK/uOvKf10cweB0I7S465HW5NrXW2 8fK5l3m3bkX4fSYRosf3hJhzMCASkQw= X-Google-Smtp-Source: AMrXdXvSx3oYpSvZkWxyqUbjO54OGU3ZwhLtg8KC5XbVkcF1tTVj73XNWDzYygyvqgXZCZvJZcQoOQ== X-Received: by 2002:a5d:4601:0:b0:242:63a3:2f20 with SMTP id t1-20020a5d4601000000b0024263a32f20mr23771755wrq.11.1672338997031; Thu, 29 Dec 2022 10:36:37 -0800 (PST) Received: from hirondell ([2001:861:38ca:5f70:7347:9ec1:df7c:18ef]) by smtp.gmail.com with ESMTPSA id z5-20020a5d4c85000000b00267e918d1ecsm2169985wrs.24.2022.12.29.10.36.35 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 29 Dec 2022 10:36:35 -0800 (PST) Date: Thu, 29 Dec 2022 19:36:44 +0100 Message-Id: <878riqukeb.fsf@gmail.com> To: control@debbugs.gnu.org From: =?utf-8?Q?K=C3=A9vin_Le_Gouguec?= Subject: control message for bug #60366 MIME-version: 1.0 Content-type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: control X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) found 60366 29.0.60 quit From unknown Sun Jun 22 17:15:40 2025 X-Loop: help-debbugs@gnu.org Subject: bug#60366: [PATCH] Simplify introduction of use-package manual Resent-From: =?UTF-8?Q?K=C3=A9vin?= Le Gouguec Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 30 Dec 2022 10:01:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 60366 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch To: 60366@debbugs.gnu.org Cc: Stefan Kangas Received: via spool by 60366-submit@debbugs.gnu.org id=B60366.16723944528887 (code B ref 60366); Fri, 30 Dec 2022 10:01:02 +0000 Received: (at 60366) by debbugs.gnu.org; 30 Dec 2022 10:00:52 +0000 Received: from localhost ([127.0.0.1]:33587 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pBCC3-0002JH-Jz for submit@debbugs.gnu.org; Fri, 30 Dec 2022 05:00:51 -0500 Received: from mail-wr1-f50.google.com ([209.85.221.50]:41592) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pBCC1-0002J2-E1 for 60366@debbugs.gnu.org; Fri, 30 Dec 2022 05:00:49 -0500 Received: by mail-wr1-f50.google.com with SMTP id w1so7356457wrt.8 for <60366@debbugs.gnu.org>; Fri, 30 Dec 2022 02:00:49 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:user-agent:message-id:date :references:in-reply-to:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=OEmfokou9JMz39pYwpGduEGBX0sAvj0oSZsrJQx+esM=; b=TX0KmqlG12f9L1cmmZbIcQ0jl+iZxJq2n2uG13z9pWq1uJvRPV6zm7iEL7W/COaN66 Dc6gaVdRzrHo3XrqhkVE8AxD7I+aC8C3fKlwcXiSE19JDLAE5C5ltf29HghLOarSXIgR MWG6wbZ4/Hz+GNPZvtO79PgUrc48Wwr2fwwvnvdksGKzLxViOIX5lHnHPXY1c3vW4/Ty J2O746rIz8f8qC4Awi6nAsU1obZn+Q9sCS7eEWCFHAlFpn6JXmwuouO4dlbp41IErP3i n7lL0puqfrdtMCQ9q4G37uLcQgyh2FB/2iS1FyhtF3WMH6Ju2b/yOSmM1a741qGOxl6N MxmQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:user-agent:message-id:date :references:in-reply-to:subject:cc:to:from:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=OEmfokou9JMz39pYwpGduEGBX0sAvj0oSZsrJQx+esM=; b=fsDNRhOarXK/pMaFSwzvBJowjjsij53UZ20JpBDA/4cuJJUSYahdEtDSmKYhB3fTyO lCODDupJXdvsVmZUupTi+xshgL/hEVFSCGcj7w958zYrULqfp+223SUPPS4qASESeGDl PQHJ7nwFqniVbtSTQQ85P1ZrH/S3pV27kYpcVDX+GVWmEKRt5yvgdZ8bw5qjxnSuNlJT 5zn6Ao5LJWMcV6nz81VQmlFrss5h0Kbddh8M87OFjdF8E5PfJXCvYJ3zlSBIoOu1T66e dCrEPZfaFtbhJctq9Jnn30g7WuZDdUGv6R7bZLMfO7UJ/jIht134PwYAjrFxoMIiAf0g TCYA== X-Gm-Message-State: AFqh2kpsrMYXwxUv61e7aw0EEJQNy6xjYG5RGpwumqlfiGd9OTNKc30q pL6iPFOdpyv4V+qOjei4/Mw= X-Google-Smtp-Source: AMrXdXtu7fdWFQUi9pXo9s+RPGo+YEoct1QUgP8sh6oO3WSDUP+szRg2Qecme9k5BIu4ZR5LPR42gA== X-Received: by 2002:a5d:4407:0:b0:27d:59a5:28c1 with SMTP id z7-20020a5d4407000000b0027d59a528c1mr9558059wrq.28.1672394443301; Fri, 30 Dec 2022 02:00:43 -0800 (PST) Received: from hirondell ([2001:861:38ca:5f70:7347:9ec1:df7c:18ef]) by smtp.gmail.com with ESMTPSA id s8-20020a5d5108000000b0028f2fdadde2sm1394969wrt.34.2022.12.30.02.00.42 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 30 Dec 2022 02:00:42 -0800 (PST) From: =?UTF-8?Q?K=C3=A9vin?= Le Gouguec In-Reply-To: <87v8lwed4a.fsf@gmail.com> ("=?UTF-8?Q?K=C3=A9vin?= Le Gouguec"'s message of "Tue, 27 Dec 2022 22:43:49 +0100") References: <87v8lwed4a.fsf@gmail.com> Date: Fri, 30 Dec 2022 11:00:52 +0100 Message-ID: <874jtdus6j.fsf@gmail.com> User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Spam-Score: 0.0 (/) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) [ CC'ing StefanK, since these specific bits were authored in 2022-12-08 "Add new use-package manual" (98e54f597e1) ] K=C3=A9vin Le Gouguec writes: > 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 th= is 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 t= he 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 it= s 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" = instead? 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. From unknown Sun Jun 22 17:15:40 2025 MIME-Version: 1.0 X-Mailer: MIME-tools 5.505 (Entity 5.505) X-Loop: help-debbugs@gnu.org From: help-debbugs@gnu.org (GNU bug Tracking System) To: =?UTF-8?Q?K=C3=A9vin?= Le Gouguec Subject: bug#60366: closed (Re: bug#60366: [PATCH] Simplify introduction of use-package manual) Message-ID: References: <87v8lwed4a.fsf@gmail.com> X-Gnu-PR-Message: they-closed 60366 X-Gnu-PR-Package: emacs X-Gnu-PR-Keywords: patch Reply-To: 60366@debbugs.gnu.org Date: Sat, 31 Dec 2022 09:53:02 +0000 Content-Type: multipart/mixed; boundary="----------=_1672480382-26519-1" This is a multi-part message in MIME format... ------------=_1672480382-26519-1 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Your bug report #60366: [PATCH] Simplify introduction of use-package manual which was filed against the emacs package, has been closed. The explanation is attached below, along with your original report. If you require more details, please reply to 60366@debbugs.gnu.org. --=20 60366: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D60366 GNU Bug Tracking System Contact help-debbugs@gnu.org with problems ------------=_1672480382-26519-1 Content-Type: message/rfc822 Content-Disposition: inline Content-Transfer-Encoding: 7bit Received: (at 60366-done) by debbugs.gnu.org; 31 Dec 2022 09:52:20 +0000 Received: from localhost ([127.0.0.1]:36566 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pBYXM-0006sW-1G for submit@debbugs.gnu.org; Sat, 31 Dec 2022 04:52:20 -0500 Received: from mail-oa1-f42.google.com ([209.85.160.42]:37384) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pBYXJ-0006sC-Mt for 60366-done@debbugs.gnu.org; Sat, 31 Dec 2022 04:52:18 -0500 Received: by mail-oa1-f42.google.com with SMTP id 586e51a60fabf-12c8312131fso27174578fac.4 for <60366-done@debbugs.gnu.org>; Sat, 31 Dec 2022 01:52:17 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:from:to:cc:subject:date :message-id:reply-to; bh=09pH1+pzPyKf539P7mhKfgQ55oHZ5/MkcA77ygwpVsI=; b=KFDOVQjYPBEbiQg3HADS0brVq0VGRLB6eDwRX70TPISGPtSSew26xAPnY3gYfVbIFf cf3pJVk6sqyIupa+ZAzFFxJejxvlihrZdeG7hOBZXdWYfxhQQOx/8tB2ALpYqmrb1Sf3 /WIWSsfHwf4ey8IojK5Qh58J2DKCbV4xV5q+DXmv8fOy/UYm+NXCg0WgaoMPtesWUk31 yzYh++9xyGICJYypujiNF6dCIDgr8zCTNyF9SRfm0YGDD2Mff55svsdnSY6tiESzOxTN vj1n7Xle5hD8T3XfqDQhCyOTUXevgBTuLvAEkk53ONlLJPgyCSGpWoZISC0OMXMXXYFi XXNg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=09pH1+pzPyKf539P7mhKfgQ55oHZ5/MkcA77ygwpVsI=; b=euEfM8IGpZ7xJS9yyHyRkJWOwW4Qkcd22xO7iL8CpXBSjkHYRB+gp0ELgHcJkXP5tQ sl2q9PQxR2+ytdDfGHjppPGtgYNoE7rvgbNj8+2Xoss3YxWLbKn+sV6GjmdWV9JAFoE/ lp0iYLnKR8sYHal8Ol95Kk5ZzjD2k3F7kK4CW2AJYTzy6W8y583jCSY67DiTBA5s7rk2 +GLt/qVJWMtAhl6PNIpcwkdpK3+a8JHTTJ+WfCsv1gGRZtiWBDmP6DFWRu7TOt4b4V5I 2e0mRdtFo6Z3S/8tDM2Vi+M6YPZsSIyoB+U+xGP87JR2cDWvqnpA4LGQdXijQHpBM1Vg aq0Q== X-Gm-Message-State: AFqh2kqc5vWTD0QvnmkfGtENPtxg6NllbS3KfjjJSBShiB5UzHXbWJYU OjjU4/TGzVmK96JiQNovUbW5bGDilyq0Pr/dK2w= X-Google-Smtp-Source: AMrXdXuXHXIHljA5T8MGUEQn2v8IWf8zW0KSlby/idrqHWh5x1fk87dPneyRnYteHk2jH3xt6HkRDYqjZFzxmlXySQo= X-Received: by 2002:a05:6870:9f86:b0:14c:667e:4620 with SMTP id xm6-20020a0568709f8600b0014c667e4620mr1577141oab.92.1672480331888; Sat, 31 Dec 2022 01:52:11 -0800 (PST) MIME-Version: 1.0 References: <87v8lwed4a.fsf@gmail.com> In-Reply-To: <87v8lwed4a.fsf@gmail.com> From: Stefan Kangas Date: Sat, 31 Dec 2022 10:52:00 +0100 Message-ID: Subject: Re: bug#60366: [PATCH] Simplify introduction of use-package manual To: =?UTF-8?Q?K=C3=A9vin_Le_Gouguec?= Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 60366-done Cc: 60366-done@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) K=C3=A9vin Le Gouguec writes: > I've made a patch against emacs-29 to simplify this part of the manual Thanks for the patch! It looks good to me, so I pushed it to emacs-29 (commit 01acecc79c3). ------------=_1672480382-26519-1 Content-Type: message/rfc822 Content-Disposition: inline Content-Transfer-Encoding: 7bit Received: (at submit) by debbugs.gnu.org; 27 Dec 2022 21:43:50 +0000 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 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 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 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 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) 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) From: =?utf-8?Q?K=C3=A9vin_Le_Gouguec?= To: bug-gnu-emacs@gnu.org Subject: [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="=-=-=" 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-Spam-Score: -1.3 (-) X-Debbugs-Envelope-To: submit X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -2.3 (--) --=-=-= 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 --=-=-=-- ------------=_1672480382-26519-1-- From unknown Sun Jun 22 17:15:40 2025 X-Loop: help-debbugs@gnu.org Subject: bug#60366: [PATCH] Simplify introduction of use-package manual Resent-From: =?UTF-8?Q?K=C3=A9vin?= Le Gouguec Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 31 Dec 2022 11:43:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 60366 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch To: Stefan Kangas Cc: 60366-done@debbugs.gnu.org Received: via spool by 60366-done@debbugs.gnu.org id=D60366.16724869468273 (code D ref 60366); Sat, 31 Dec 2022 11:43:02 +0000 Received: (at 60366-done) by debbugs.gnu.org; 31 Dec 2022 11:42:26 +0000 Received: from localhost ([127.0.0.1]:36716 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pBaFt-00029N-JK for submit@debbugs.gnu.org; Sat, 31 Dec 2022 06:42:25 -0500 Received: from mail-wr1-f44.google.com ([209.85.221.44]:41926) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pBaFr-000295-Hr for 60366-done@debbugs.gnu.org; Sat, 31 Dec 2022 06:42:24 -0500 Received: by mail-wr1-f44.google.com with SMTP id w1so10063022wrt.8 for <60366-done@debbugs.gnu.org>; Sat, 31 Dec 2022 03:42:23 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:user-agent:message-id:date :references:in-reply-to:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=owDEljnwJ+Ectnutjl3ni5mWsIMuOUWe/NnpD5F1SnQ=; b=DYYt2DQ+GnaGfj7FmiHWIrnqPDow/HW7Z2rHMbQTmpsi6MZn4CEDDwjEnvkXIbGQ8q t5Y6FbNKybkGsdiPDNuPJin6/lbiVzyD1OZI4I4h1VACWfcmXRrMxL52qunvJqXFWybf CS95oKJ3C52leGRfffiPAF6kowfO3kyNqh5mwsg4j0UUwgCXyuXxbGlQkXmke5gksZD2 K6nGWfqpkTEsaA9jWyxxCr2Y+4oI76lz6LhJknxSixEeiAOtriLuEtdOM0ZJ9BE5J/M/ +tHWpBoSOfzgN0U1p7czz5Q3WgbyYMMe8inF3eb0iqBPTEvHvaKP8mNwcxQmCpytv9P0 Y5ZA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:user-agent:message-id:date :references:in-reply-to:subject:cc:to:from:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=owDEljnwJ+Ectnutjl3ni5mWsIMuOUWe/NnpD5F1SnQ=; b=wgyK++VsEaJ1RcH7yorHpdGllJ/mbci6riNrdoV1Un+YYs3FLa3V7CpXIP5fAsP0mD chclGAPpi5/oJg2mDEbgoPFWQ4q1tFn+cpWJWSmJHlp3Eq2A8ucj/7FXGRPFNTWU5N6Y gZ1FS2PUOM9PR5zM00AvcrXcGwrzh7vUozVAmCu2zbALjAQdJ1pvsqU1smWRujkU92F0 F4oiAdM2oH22TTjSW6t70E5EiEUBQuboW1aQcLTVuq+5BMk6emiIYElzqEDEw1iVDvBs 676RAFf+43Gav0CXGKcUZjk2qjvJddwO1bJKvaO/hq1XmpgXpUALu7nE3IhixT5PBQsn nytQ== X-Gm-Message-State: AFqh2kr2uYCeWQUhFBrtON1PFAhXJyEoAcPA/IO+91kpVRWNm1WwQR/Z zbivc18LMqz+YfaY0aYxKhD2Lrq1R08= X-Google-Smtp-Source: AMrXdXsKfrs9PD1jBJMrp5tg6eVCs5Ovzcl8eB5X8wsEb0WfwfVrsmxrExDp/RQZhytIEEJTPyYVDQ== X-Received: by 2002:adf:eb8c:0:b0:248:ab8a:5144 with SMTP id t12-20020adfeb8c000000b00248ab8a5144mr19882682wrn.63.1672486937193; Sat, 31 Dec 2022 03:42:17 -0800 (PST) Received: from hirondell ([2001:861:38ca:5f70:7347:9ec1:df7c:18ef]) by smtp.gmail.com with ESMTPSA id w14-20020adfee4e000000b002422bc69111sm27697167wro.9.2022.12.31.03.42.16 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 31 Dec 2022 03:42:16 -0800 (PST) From: =?UTF-8?Q?K=C3=A9vin?= Le Gouguec In-Reply-To: (Stefan Kangas's message of "Sat, 31 Dec 2022 10:52:00 +0100") References: <87v8lwed4a.fsf@gmail.com> Date: Sat, 31 Dec 2022 12:42:26 +0100 Message-ID: <87fscvu7dp.fsf@gmail.com> User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Spam-Score: 0.0 (/) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) Stefan Kangas writes: > K=C3=A9vin Le Gouguec writes: > >> I've made a patch against emacs-29 to simplify this part of the manual > > Thanks for the patch! It looks good to me, so I pushed it to emacs-29 > (commit 01acecc79c3). My pleasure =F0=9F=99=8F