From: "Basil L. Contovounesios" <contovob@tcd.ie>
To: Mariano Montone <marianomontone@gmail.com>
Cc: emacs-devel@gnu.org
Subject: Re: How to include Info manuals in packages?
Date: Fri, 27 Jan 2023 00:25:25 +0000 [thread overview]
Message-ID: <87h6wczuve.fsf@tcd.ie> (raw)
In-Reply-To: <d850422b-68ae-f460-ad94-49ee88ed5533@gmail.com> (Mariano Montone's message of "Thu, 26 Jan 2023 15:39:42 -0300")
Mariano Montone [2023-01-26 15:39 -0300] wrote:
> I'm considering adding a manual an Info format to my package. My package is
> installable from ELPA.
>
> I have these questions:
>
> 1) Is it good practice to include an Info manual in same package that contains
> the package source code?
Yes, but you need to check in only the .texi file. GNU ELPA will then
automatically generate the required 'dir' and .info files and include
them in the package tarball.
> 2) How to get the Info manual installed when the user installs my package?
If you tell GNU ELPA where to find the .texi file, then it (and
package.el) should handle the rest automatically for you.
This is specified in the elpa-packages file under elpa.git:
https://git.sv.gnu.org/cgit/emacs/elpa.git/tree/elpa-packages
Look for the :doc keyword for examples.
The available keywords are documented in the repo's README:
https://git.sv.gnu.org/cgit/emacs/elpa.git/tree/README
Finally, what happens during package-install is mentioned under
(info "(elisp) Multi-file Packages").
HTH,
--
Basil
next prev parent reply other threads:[~2023-01-27 0:25 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-01-26 18:39 How to include Info manuals in packages? Mariano Montone
2023-01-27 0:25 ` Basil L. Contovounesios [this message]
2023-01-27 0:28 ` Mariano Montone
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=87h6wczuve.fsf@tcd.ie \
--to=contovob@tcd.ie \
--cc=emacs-devel@gnu.org \
--cc=marianomontone@gmail.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).