From: David Masterson <dsmasterson@gmail.com>
To: Philip Kaludercic <philipk@posteo.net>
Cc: emacs-devel@gnu.org
Subject: Re: (M)Elpa & info/diir files ?
Date: Sun, 12 Mar 2023 13:34:01 -0700 [thread overview]
Message-ID: <SJ0PR03MB5455455B1D1432FFF2E774DAA2B89@SJ0PR03MB5455.namprd03.prod.outlook.com> (raw)
In-Reply-To: <87mt4inooi.fsf@posteo.net> (Philip Kaludercic's message of "Sun, 12 Mar 2023 12:23:41 +0000")
Philip Kaludercic <philipk@posteo.net> writes:
> 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).
A few questions:
1. Does Elpa kick the Makefile in a package?
2. How does it know what arguments to give Make? Package recipe file?
3. How does Elpa ensure it is picking up (say) the right Org for org->texi?
MELPA.org has some documentation in its Github repo. Does ELPA have
similar documentation? If so, where?
> 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.
Understood. Goal was to get the flow working. Then we can create a
PKG.org file from which a small README.org (or .md) and full PKG.info
can be generated.
--
David Masterson
next prev parent reply other threads:[~2023-03-12 20:34 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
2023-03-12 20:34 ` David Masterson [this message]
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
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=SJ0PR03MB5455455B1D1432FFF2E774DAA2B89@SJ0PR03MB5455.namprd03.prod.outlook.com \
--to=dsmasterson@gmail.com \
--cc=emacs-devel@gnu.org \
--cc=philipk@posteo.net \
/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).