unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Stephen Leake <stephen_leake@stephe-leake.org>
To: emacs-devel <emacs-devel@gnu.org>
Subject: installed packages long description.
Date: Tue, 04 Dec 2018 17:39:39 -0800	[thread overview]
Message-ID: <868t14kazo.fsf@stephe-leake.org> (raw)

When browsing the *Packages* buffer produced by 'list-packages', the ?
key gives a package description. That includes a "long description",
which for multi-file packages is taken from a README file. For
single-file packages it is taken from a Commentary comment header.

However, if that description was not viewed before a package was
installed, it is not displayed in the description.

The problem is the way describe-package retrieves the long description.
If the package is not installed, the package-desc struct archive field
has a value, and describe-package requests (format "%s-readme.txt" name)
from the archive server. Apparently the webserver on the archive
responds with the contents of <pkg>/README or the Commentary comment
header. describe-package then saves that in
~/.emacs.d/elpa/<pkg>-readme.txt.

However, if the package is installed, the package-desc struct
archive field does not have a value. Then describe-package looks for
~/.emacs.d/elpa/<pkg>-readme.txt, which does not exist if the
description was never viewed before installation.

I see two solutions; describe-package can also look for README or the
Commentary comment header, or package-install can always populate
~/.emacs.d/elpa/<pkg>-readme.txt

preferences?

-- 
-- Stephe



             reply	other threads:[~2018-12-05  1:39 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-12-05  1:39 Stephen Leake [this message]
2018-12-09 16:38 ` installed packages long description Stefan Monnier
2018-12-09 18:46   ` Stephen Leake
2018-12-10  2:40     ` Stefan Monnier
2018-12-10 19:27       ` Stephen Leake
2018-12-11 20:01         ` Stefan Monnier
2018-12-12  1:46           ` Stephen Leake
2018-12-12  2:02             ` Stefan Monnier
2018-12-13 14:49               ` Stephen Leake
2018-12-13 15:24                 ` Stefan Monnier
2018-12-13 22:47                   ` Stephen Leake

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=868t14kazo.fsf@stephe-leake.org \
    --to=stephen_leake@stephe-leake.org \
    --cc=emacs-devel@gnu.org \
    /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).