all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Philip Kaludercic <philipk@posteo.net>
To: David Masterson <dsmasterson@gmail.com>
Cc: emacs-devel@gnu.org
Subject: Re: (M)Elpa & info/diir files ?
Date: Sun, 12 Mar 2023 12:23:41 +0000	[thread overview]
Message-ID: <87mt4inooi.fsf@posteo.net> (raw)
In-Reply-To: <SJ0PR03MB545590CB4A9B4309DAB9CB65A2B89@SJ0PR03MB5455.namprd03.prod.outlook.com> (David Masterson's message of "Sat, 11 Mar 2023 19:01:35 -0800")

David Masterson <dsmasterson@gmail.com> writes:

> In an Emacs package that has a README.org, it's easy to build a Makefile
> which generates an .info file for inclusion in the package.  However,
> does this imply that the .info file must be checked into the git repo
> for (M)Elpa to pick it up for inclusion in the package?  Is this the
> standard?  I don't like checking in derivative files unnecessarily.

I can only speak for {GNU,NonGNU} ELPA, but no the build system can
generate .info files from .org or .texi files (which also means that you
don't need to check in .texi files if your manual is written using
org-mode and exported using ox-texinfo).

But on a different note, I would advise against using the README file as
the manual.  The README is IMO better suited as a brief explanation of a
package with a few pointers than an exhaustive resource.  When I want to
check out a package using C-h P, I'd rather have the content fit on my
screen without having to scroll.

-- 
Philip Kaludercic



  reply	other threads:[~2023-03-12 12:23 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-03-12  3:01 (M)Elpa & info/diir files ? David Masterson
2023-03-12 12:23 ` Philip Kaludercic [this message]
2023-03-12 20:34   ` David Masterson
2023-03-12 23:00     ` Philip Kaludercic

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

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

  git send-email \
    --in-reply-to=87mt4inooi.fsf@posteo.net \
    --to=philipk@posteo.net \
    --cc=dsmasterson@gmail.com \
    --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 external index

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

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.