How to include Info manuals in packages?

How to include Info manuals in packages?

[Mariano Montone]

Hello,

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?

2) How to get the Info manual installed when the user installs my package?


Thank you,

       Mariano

Re: How to include Info manuals in packages?

[Basil L. Contovounesios]

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

Re: How to include Info manuals in packages?

[Mariano Montone]

Basil,

    thanks for the info! Much appreciated.

Mariano

El 26/1/23 a las 21:25, Basil L. Contovounesios escribió:
> 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,
>