unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Stefan Kangas <stefan@marxist.se>
Cc: 29420@debbugs.gnu.org
Subject: bug#29420: 26.0; doc of `list-packages'
Date: Sun, 20 Oct 2019 18:58:01 +0300	[thread overview]
Message-ID: <83zhhv4dfa.fsf@gnu.org> (raw)
In-Reply-To: <CADwFkmkgN-mhzXdZMukx-tTPaPvLO74L3cVCgKzs1AUszTe-RA@mail.gmail.com> (message from Stefan Kangas on Sun, 20 Oct 2019 17:42:09 +0200)

> From: Stefan Kangas <stefan@marxist.se>
> Date: Sun, 20 Oct 2019 17:42:09 +0200
> Cc: Drew Adams <drew.adams@oracle.com>, 29420@debbugs.gnu.org
> 
> Thanks.  I decided to add a new section to not make the "Package Menu"
> node too cluttered.  What do you think?

It should rather be a subsection of "Package Menu", since that's where
you talk about 'status', and it should follow "Package Menu".
Otherwise, in the printed manual, the text which starts "Package
Status" will come out of the blue, with nothing to connect it to the
previous or the next section.

> +or @samp{built-in} (included in Emacs by default).  For more
> +details, @xref{Package Status}.

@xref produces a capitalize "See", so it is inappropriate in the
middle of a sentence.  You want "see @ref" here.

> +
> +@item
> +Which package archive this package is from, if you have more than one
> +package archive.
>  
>  @item
>  A short description of the package.
> @@ -123,7 +117,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
>  @vindex package-menu-async
> @@ -303,6 +297,60 @@ Package Installation
>  installed will be ignored.  The @samp{muse} package will be listed in
>  the package menu with the @samp{held} status.
>  
> +@node Package Status
> +@section Package Status
> +@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 from the package
> +archive.
> +
> +@c @samp{unsigned} (installed, but not signed; @pxref{Package Signing}),
> +
> +@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 installed
> +The package is installed.
> +
> +@item dependency
> +The package was installed automatically to satisfy a dependency of
> +another package.
> +
> +@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.
> +
> +@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 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 built-in packages and cannot be deleted.
> +
> +@item incompat
> +The package cannot be installed for some reason, for example because
> +it depends on uninstallable packages.
> +
> +@item held
> +The package is held, @xref{Package Installation}.
> +@end table

Maybe the table should be organized in alphabetical order?  Not sure.

Thanks, looks fine with these nits fixed.





  reply	other threads:[~2019-10-20 15:58 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-11-24  2:05 bug#29420: 26.0; doc of `list-packages' Drew Adams
2017-11-24 14:52 ` Eli Zaretskii
2019-10-19  2:04 ` Stefan Kangas
2019-10-19  5:25   ` Drew Adams
2019-10-19  6:42   ` Eli Zaretskii
2019-10-20 15:42     ` Stefan Kangas
2019-10-20 15:58       ` Eli Zaretskii [this message]
2019-10-21 23:43         ` Stefan Kangas
2019-10-22 15:20           ` Eli Zaretskii
2019-10-23 14:57             ` Stefan Kangas
2019-10-23 15:47               ` Eli Zaretskii
2019-11-11 14:53                 ` Stefan Kangas
2019-11-14 11:07                   ` Eli Zaretskii
2019-11-15  3:38                     ` Stefan Kangas
2020-01-15  1:27                       ` Stefan Kangas
     [not found] <<eb6a7e65-28f5-4a3a-86af-c4cca01e0427@default>
     [not found] ` <<838tevafus.fsf@gnu.org>
2017-11-24 17:02   ` Drew Adams

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=83zhhv4dfa.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=29420@debbugs.gnu.org \
    --cc=stefan@marxist.se \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).