unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Stefan Monnier <monnier@iro.umontreal.ca>
To: raman <raman@google.com>
Cc: emacs-devel@gnu.org
Subject: Re: Info Pages for ELPA  packages
Date: Mon, 26 May 2014 13:54:39 -0400	[thread overview]
Message-ID: <jwvsinwv3ek.fsf-monnier+emacs@gnu.org> (raw)
In-Reply-To: <87wqd988b4.fsf@gmail.com> (raman@google.com's message of "Sun, 25 May 2014 21:37:03 -0700")

The situation w.r.t to documentation of ELPA packages indeed could be
improved at various stages:
- Many packages don't have much documentation.  That's also true of many
  Elisp packages bundled with Emacs, but it's probably more true of
  ELPA packages.  We could encourage people to provide docs, but that
  problem seems different from the one you raise.
- Some have documentation but it's not made easily accessible to
  the user.  This is because the GNU ELPA infrastructure is fairly
  limited in this respect:
  - package.el only knows how to use an Info doc and only if the package
    comes with a "dir" file.
  - the GNU ELPA scripts don't know how to build Info files nor "dir" files.

So improving the GNU ELPA scripts to generate the Info and "dir" files
would probably be a good first step.  If you have specific packages
which included docs in the Git repo but no Info&dir files, please send
them along, they'll be helpful to try and figure out how those scripts
could/should work.


        Stefan



  reply	other threads:[~2014-05-26 17:54 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-05-25  0:01 Info Pages for ELPA packages T. V. Raman
2014-05-25  1:41 ` Glenn Morris
2014-05-25 22:05 ` Mario Lang
2014-05-26  4:37   ` raman
2014-05-26 17:54     ` Stefan Monnier [this message]
2014-05-26 22:38       ` T.V Raman
2014-05-27  2:40       ` Eric Abrahamsen
2014-05-27  2:47         ` raman
2014-05-27  3:25           ` Stefan Monnier
2014-05-27 15:23             ` T.V Raman
2014-05-27 16:03               ` Stephen J. Turnbull
2014-05-27 19:49               ` Stefan Monnier
2014-05-27  3:26         ` Stefan Monnier
2014-05-27  4:43           ` Eric Abrahamsen
2014-05-27 10:06       ` Mario Lang
2014-05-27 11:50         ` Michael Albinus

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=jwvsinwv3ek.fsf-monnier+emacs@gnu.org \
    --to=monnier@iro.umontreal.ca \
    --cc=emacs-devel@gnu.org \
    --cc=raman@google.com \
    /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).