From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Stefan Kangas Newsgroups: gmane.emacs.bugs Subject: bug#29420: 26.0; doc of `list-packages' Date: Fri, 15 Nov 2019 04:38:30 +0100 Message-ID: <871ru9oll5.fsf@marxist.se> References: <83zhhx6xsr.fsf@gnu.org> <83zhhv4dfa.fsf@gnu.org> <8336fk24dx.fsf@gnu.org> <83imofzcof.fsf@gnu.org> <87mud2piqa.fsf@marxist.se> <83imnm7m34.fsf@gnu.org> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="81262"; mail-complaints-to="usenet@blaine.gmane.org" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.0.50 (gnu/linux) Cc: 29420@debbugs.gnu.org To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Nov 15 04:39:15 2019 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([209.51.188.17]) by blaine.gmane.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1iVSS2-000L1r-IA for geb-bug-gnu-emacs@m.gmane.org; Fri, 15 Nov 2019 04:39:14 +0100 Original-Received: from localhost ([::1]:35168 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iVSS1-0007Cj-Fd for geb-bug-gnu-emacs@m.gmane.org; Thu, 14 Nov 2019 22:39:13 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:44457) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iVSRt-0007CK-4w for bug-gnu-emacs@gnu.org; Thu, 14 Nov 2019 22:39:06 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iVSRr-0004U4-Im for bug-gnu-emacs@gnu.org; Thu, 14 Nov 2019 22:39:05 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:54880) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1iVSRr-0004Tx-FL for bug-gnu-emacs@gnu.org; Thu, 14 Nov 2019 22:39:03 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1iVSRr-0005sJ-9P for bug-gnu-emacs@gnu.org; Thu, 14 Nov 2019 22:39:03 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Stefan Kangas Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 15 Nov 2019 03:39:03 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 29420 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 29420-submit@debbugs.gnu.org id=B29420.157378912222556 (code B ref 29420); Fri, 15 Nov 2019 03:39:03 +0000 Original-Received: (at 29420) by debbugs.gnu.org; 15 Nov 2019 03:38:42 +0000 Original-Received: from localhost ([127.0.0.1]:35468 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iVSRW-0005rk-9m for submit@debbugs.gnu.org; Thu, 14 Nov 2019 22:38:42 -0500 Original-Received: from host.gofardesign.uk ([208.79.239.190]:42942) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iVSRT-0005rW-UK for 29420@debbugs.gnu.org; Thu, 14 Nov 2019 22:38:40 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=marxist.se; s=default; h=Content-Type:MIME-Version:Message-ID:Date:References: In-Reply-To:Subject:Cc:To:From:Sender:Reply-To:Content-Transfer-Encoding: Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender: Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=ttbz7olNBoZtgcv38g7pTAs6UR7AC6ysqWMlvcfqJ7E=; b=pkfFOkR/DxJp3NlqKWRiLRPION 4oo74wySTUn+WxiwG7+V9YjCPSLiuIghOsgM1h6VGeZG1CHIH9Za9rHaJYkjehidIgUn9xlwOxZeP cTvN1JNvrMTZkRcRmqCvxxYklCsdn0JBgdjb5EXCjvoEba4xewHd/NSsJzuf5oKsqXXk=; Original-Received: from h-70-69.a785.priv.bahnhof.se ([155.4.70.69]:55596 helo=localhost) by host.gofardesign.uk with esmtpsa (TLSv1.2:ECDHE-RSA-AES256-GCM-SHA384:256) (Exim 4.92) (envelope-from ) id 1iVSRM-0007EB-RR; Thu, 14 Nov 2019 21:38:34 -0600 In-Reply-To: <83imnm7m34.fsf@gnu.org> (Eli Zaretskii's message of "Thu, 14 Nov 2019 13:07:27 +0200") X-OutGoing-Spam-Status: No, score=-1.0 X-AntiAbuse: This header was added to track abuse, please include it with any abuse report X-AntiAbuse: Primary Hostname - host.gofardesign.uk X-AntiAbuse: Original Domain - debbugs.gnu.org X-AntiAbuse: Originator/Caller UID/GID - [47 12] / [47 12] X-AntiAbuse: Sender Address Domain - marxist.se X-Get-Message-Sender-Via: host.gofardesign.uk: authenticated_id: stefan@marxist.se X-Authenticated-Sender: host.gofardesign.uk: stefan@marxist.se X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 209.51.188.43 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.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:171628 Archived-At: --=-=-= Content-Type: text/plain Eli Zaretskii writes: >> I believe the attached patch does the right things, but it would be >> good if someone more familiar with texinfo had a look. > > One thing you missed is that the detailed menu in emacs.texi also > needs to be updated, exactly like you did here: > >> @menu >> * Package Menu:: Buffer for viewing and managing packages. >> +* Package Statuses:: Which statuses a package can have. >> * Package Installation:: Options for package installation. >> * Package Files:: Where packages are installed. >> @end menu Thanks, fixed in the attached. I'll commit it in a couple of days if there are no further comments. Best regards, Stefan Kangas --=-=-= Content-Type: text/x-diff Content-Disposition: inline; filename=0001-Add-new-node-Package-Statuses-to-manual.patch >From d141e19f516d3f7b69f46d81504167c633941db9 Mon Sep 17 00:00:00 2001 From: Stefan Kangas Date: Tue, 22 Oct 2019 01:42:41 +0200 Subject: [PATCH] Add new node "Package Statuses" to manual * doc/emacs/emacs.texi (Top): * doc/emacs/package.texi (Package Menu): New node "Package Statuses". (Bug#29420) --- doc/emacs/emacs.texi | 1 + doc/emacs/package.texi | 76 ++++++++++++++++++++++++++++++++++-------- 2 files changed, 63 insertions(+), 14 deletions(-) diff --git a/doc/emacs/emacs.texi b/doc/emacs/emacs.texi index d23e682cc8..c832d43782 100644 --- a/doc/emacs/emacs.texi +++ b/doc/emacs/emacs.texi @@ -1098,6 +1098,7 @@ Top Emacs Lisp Packages * Package Menu:: Buffer for viewing and managing packages. +* Package Statuses:: Which statuses a package can have. * Package Installation:: Options for package installation. * Package Files:: Where packages are installed. diff --git a/doc/emacs/package.texi b/doc/emacs/package.texi index 1c0f853427..a977abcd29 100644 --- a/doc/emacs/package.texi +++ b/doc/emacs/package.texi @@ -32,6 +32,7 @@ Packages @menu * Package Menu:: Buffer for viewing and managing packages. +* Package Statuses:: Which statuses a package can have. * Package Installation:: Options for package installation. * Package Files:: Where packages are installed. @end menu @@ -57,19 +58,12 @@ Package Menu The package's status---normally one of @samp{available} (can be downloaded from the package archive), @samp{installed}, @c @samp{unsigned} (installed, but not signed; @pxref{Package Signing}), -or @samp{built-in} (included in Emacs by default). The status -@samp{external} means the package is not built-in and not from the -directory specified by @code{package-user-dir} (@pxref{Package -Files}). External packages are treated much like built-in: they -cannot be deleted through the package menu, and are not considered for -upgrading. - -The status can also be @samp{new}. This is equivalent to -@samp{available}, except that it means the package became newly -available on the package archive after your last invocation of -@kbd{M-x list-packages}. In other instances, a package may have the -status @samp{held}, @samp{disabled}, or @samp{obsolete}. -@xref{Package Installation}. +or @samp{built-in} (included in Emacs by default). +@xref{Package Statuses}. + +@item +Which package archive this package is from, if you have more than one +package archive enabled. @item A short description of the package. @@ -139,7 +133,7 @@ Package Menu Mark all package with a newer available version for upgrading (@code{package-menu-mark-upgrades}). This places an installation mark on the new available versions, and a deletion mark on the old -installed versions. +installed versions (marked with status @samp{obsolete}). @item x @kindex x @r{(Package Menu)} @@ -195,6 +189,60 @@ Package Menu For example, you can install a package by typing @kbd{i} on the line listing that package, followed by @kbd{x}. +@node Package Statuses +@section Package Statuses +@cindex package status + +A package can have one of the following statuses: + +@table @samp +@item available +The package is not installed, but can be downloaded and installed from +the package archive. + +@item avail-obso +The package is available for installation, but a newer version is also +available. Packages with this status are hidden by default. + +@item built-in +The package is included in Emacs by default. It cannot be deleted +through the package menu, and is not considered for upgrading. + +@item dependency +The package was installed automatically to satisfy a dependency of +another package. + +@item disabled +The package has been disabled using the @code{package-load-list} +variable. + +@item external +The package is not built-in and not from the directory specified by +@code{package-user-dir} (@pxref{Package Files}). External packages +are treated much like @samp{built-in} packages and cannot be deleted. + +@item held +The package is held, @xref{Package Installation}. + +@item incompat +The package cannot be installed for some reason, for example because +it depends on uninstallable packages. + +@item installed +The package is installed. + +@item new +Equivalent to @samp{available}, except that the package became newly +available on the package archive after your last invocation of +@kbd{M-x list-packages}. + +@item obsolete +The package is an outdated installed version; in addition to this +version of the package, a newer version is also installed. + +@c @samp{unsigned} (installed, but not signed; @pxref{Package Signing}), +@end table + @node Package Installation @section Package Installation -- 2.20.1 --=-=-=--