From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Stefan Kangas Newsgroups: gmane.emacs.bugs Subject: bug#50825: master 44dbc11: Note that the Packaging sub-nodes are mostly for maintainers Date: Mon, 27 Sep 2021 05:47:49 -0700 Message-ID: References: <20210927041333.1836.5637@vcs0.savannah.gnu.org> <20210927041334.574B220A5E@vcs0.savannah.gnu.org> 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="10998"; mail-complaints-to="usenet@ciao.gmane.io" To: Lars Ingebrigtsen , 50825@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Mon Sep 27 14:48:21 2021 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 1mUq3P-0002bO-6g for geb-bug-gnu-emacs@m.gmane-mx.org; Mon, 27 Sep 2021 14:48:19 +0200 Original-Received: from localhost ([::1]:51522 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mUq3O-00049d-4j for geb-bug-gnu-emacs@m.gmane-mx.org; Mon, 27 Sep 2021 08:48:18 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:37398) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mUq39-00046s-4a for bug-gnu-emacs@gnu.org; Mon, 27 Sep 2021 08:48:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:56693) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mUq38-0007Rj-R0 for bug-gnu-emacs@gnu.org; Mon, 27 Sep 2021 08:48:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1mUq37-0008E5-OY for bug-gnu-emacs@gnu.org; Mon, 27 Sep 2021 08:48:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Stefan Kangas Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 27 Sep 2021 12:48:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 50825 X-GNU-PR-Package: emacs Original-Received: via spool by 50825-submit@debbugs.gnu.org id=B50825.163274687831607 (code B ref 50825); Mon, 27 Sep 2021 12:48:01 +0000 Original-Received: (at 50825) by debbugs.gnu.org; 27 Sep 2021 12:47:58 +0000 Original-Received: from localhost ([127.0.0.1]:40006 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mUq33-0008Di-Si for submit@debbugs.gnu.org; Mon, 27 Sep 2021 08:47:58 -0400 Original-Received: from mail-pg1-f181.google.com ([209.85.215.181]:45659) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mUq32-0008DU-0d for 50825@debbugs.gnu.org; Mon, 27 Sep 2021 08:47:56 -0400 Original-Received: by mail-pg1-f181.google.com with SMTP id n18so17665731pgm.12 for <50825@debbugs.gnu.org>; Mon, 27 Sep 2021 05:47:55 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:in-reply-to:references:mime-version:date:message-id:subject:to :content-transfer-encoding; bh=/P+9wllomEJxOfeEFV0K3sHl3IMhbHEp5Yf7/OXYBwo=; b=figkXFDzkh91Q8xHEp9DgAb4oluzsxD1xO4Q6w7y3hOEMr8KXD9bcHgpulHMmd3fm5 DP9JVyLF7Tqg2S1ayJtviDd8oyyzKLIxBzG2mJtsUzu9xLKcZYpDuQqCsOfqZpHHNEFz ZBtK3hAaMh2CjjveWJe3PMfJjWLhVpw3HxdjXIO/eiFWifTvyzaiCgp68dx9XwRaJJgS eLAXElWLYsqBvDf4lW07X5s4KRyxEuxWNhxYnhGKjdiSf6sS+MYLASEbxHSSVsw6kSdf RZ5nhwt9xR85RJjWonV/EmSoZrN+PlyysTIFYg+uzIii1bxzcEUhy51xfcNdeYPA2fRW tLLg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:in-reply-to:references:mime-version:date :message-id:subject:to:content-transfer-encoding; bh=/P+9wllomEJxOfeEFV0K3sHl3IMhbHEp5Yf7/OXYBwo=; b=70A6maHT6+KfEg2X9sCNXG7sen7j82t4+pQ/lRZY7Kt/NV6TVhDYlbP7a/Nc36iJcP L/gfdI+SmuyniA3deHXgOvxM+0K96mcZRanwDaEyevAI8E4nyfVKixTIl/BeQA8bWcia +kT1zdfCvYt7z/JvwNfIxVKwrHUcLI9jG1k95WSNMjU1TA7gaJPI84ZNXwSKIJ0brbht 2lCNghMB7uvtPnkRa6h06xKXseh0lhhsIcelJfOmAPJH26h99wCRMi5ZJ7dbtBBSX8F8 MIlHEIFQR8vyrvfT1D0t8Uz3Kwn3EJ7EtH+8ZoZAqBnseIEpSJiXKW5Ub9DLXDFnAchI zM7g== X-Gm-Message-State: AOAM533X0BOaPSMaBXRYj2LpY+7qKHqfODCKmo/2Wl6G6Yd5aInu/mwJ 5Ra1mQ10YvCbYk5+E2fZV/Lgh2fR/GrwaKG3y6E= X-Google-Smtp-Source: ABdhPJzXzhinakI+6nUe35NbBWAV0wJQ0Ks4wdnZbNa7wq294oSrZCRlgXp7EJ8jisGyBisubtRVWzW3lT/5VPR/PBw= X-Received: by 2002:a63:f946:: with SMTP id q6mr16470515pgk.42.1632746869978; Mon, 27 Sep 2021 05:47:49 -0700 (PDT) Original-Received: from 753933720722 named unknown by gmailapi.google.com with HTTPREST; Mon, 27 Sep 2021 05:47:49 -0700 In-Reply-To: <20210927041334.574B220A5E@vcs0.savannah.gnu.org> 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" Xref: news.gmane.io gmane.emacs.bugs:215657 Archived-At: larsi@gnus.org (Lars Ingebrigtsen) writes: > branch: master > commit 44dbc11ff7bdccc8af2cdd311e6ebacfef2c43a7 > Author: Lars Ingebrigtsen > Commit: Lars Ingebrigtsen > > Note that the Packaging sub-nodes are mostly for maintainers > > * doc/lispref/package.texi (Packaging): Note that the information > is mostly for ELPA maintainers (bug#50825). > --- > doc/lispref/package.texi | 5 +++++ > 1 file changed, 5 insertions(+) > > diff --git a/doc/lispref/package.texi b/doc/lispref/package.texi > index 9c033fe..aeb455b 100644 > --- a/doc/lispref/package.texi > +++ b/doc/lispref/package.texi > @@ -17,6 +17,11 @@ put it in a @dfn{package archive} for others to downlo= ad. > @xref{Packages,,, emacs, The GNU Emacs Manual}, for a description of > user-level features of the packaging system. > > + These sections are mostly directed towards package archive > +maintainers---much of this information is not relevant for package > +authors (i.e., people who write code that will be distributed via > +these archives). > + > @menu > * Packaging Basics:: The basic concepts of Emacs Lisp packages. > * Simple Packages:: How to package a single .el file. If this entire section is only relevant for package archive maintainers, I think it should be wrapped in "@ifnottex" so it's excluded from the printed manual. But it seems to me that, while of the information indeed almost only relevant for package maintainers, at least some part of it is useful for package developers. Do you agree? See for example this paragraph in (info "(elisp) Packaging Basics"). Installing a package, either via the command =E2=80=98package-instal= l-file=E2=80=99, or via the Package Menu, creates a subdirectory of =E2=80=98package-use= r-dir=E2=80=99 named =E2=80=98NAME-VERSION=E2=80=99, where NAME is the package=E2=80= =99s name and VERSION its version (e.g., =E2=80=98~/.emacs.d/elpa/auctex-11.86/=E2=80=99). And then it repeats some stuff about `package-activate-all' that is presumably already said in the user manual. See also (info "(elisp) Simple Packages"). Perhaps we should think about it a bit more and make it more clear who this documentation is intended for? Once we know that, it should be easier to make any necessary changes. For example, if this is indeed all mixed up, could we split this up into two subchapters or something? In the more user-oriented section, we could skip many of the more low-level details and just focus on: here's what you need to do to produce a valid package. Or perhaps that should be documented by the package archives themselves? Or is that in the user manual? Etc.