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: Fri, 30 Dec 2022 11:00:52 +0100 Message-ID: <874jtdus6j.fsf@gmail.com> References: <87v8lwed4a.fsf@gmail.com> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="16103"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Cc: Stefan Kangas To: 60366@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Fri Dec 30 11:01:45 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 1pBCCv-00043d-1M for geb-bug-gnu-emacs@m.gmane-mx.org; Fri, 30 Dec 2022 11:01:45 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pBCCa-0004c4-4I; Fri, 30 Dec 2022 05:01:27 -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 1pBCCF-0004UE-50 for bug-gnu-emacs@gnu.org; Fri, 30 Dec 2022 05:01:04 -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 1pBCCE-0005tu-H2 for bug-gnu-emacs@gnu.org; Fri, 30 Dec 2022 05:01:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pBCCE-0002Jm-43 for bug-gnu-emacs@gnu.org; Fri, 30 Dec 2022 05:01: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: 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 Original-Received: via spool by 60366-submit@debbugs.gnu.org id=B60366.16723944528887 (code B ref 60366); Fri, 30 Dec 2022 10:01:02 +0000 Original-Received: (at 60366) by debbugs.gnu.org; 30 Dec 2022 10:00:52 +0000 Original-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 Original-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 Original-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) Original-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) 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") 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:252105 Archived-At: [ 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.