From: Philip Kaludercic <philipk@posteo.net>
To: Okamsn <okamsn@protonmail.com>
Cc: emacs-devel@gnu.org
Subject: Re: How to install documentation in sub-directory with Package VC?
Date: Tue, 14 Mar 2023 15:56:34 +0000 [thread overview]
Message-ID: <87bkkvconh.fsf@posteo.net> (raw)
In-Reply-To: <b4166830-144f-3818-c801-274a0cf4dc72@protonmail.com> (okamsn@protonmail.com's message of "Tue, 14 Mar 2023 03:13:11 +0000")
Okamsn <okamsn@protonmail.com> writes:
> Hello,
>
> I am trying to install a package I wrote using Package VC from Github:
> https://github.com/okamsn/loopy/tree/fix-comp-warnings
>
> The lisp files, which are in the root of the project, are installed, but
> the documentation file "loopy.texi" is in a subfolder "doc":
> https://github.com/okamsn/loopy/tree/fix-comp-warnings/doc
>
> The presence of this file does not trigger the call to makeinfo.
> The function `package-vc--unpack-1` seems to look for the keyword ":doc"
> in the package description or package spec, which I have tried adding to
> the file "loopy-pkg.el" and to the list passed to `package-vc-install`
> as `:doc "doc/loopy.texi"`.
Note that the -pkg.el file is overwritten (as does elpa-admin.el for all
packages on GNU and NonGNU ELPA), as the package metadata is taken from
the main file.
The other issue is that -pkg.el files are used to generate package
descriptors, while :doc is part of the package specification.
> What is the correct way to make Package VC install the documentation
> contained in the sub-folder?
Package-vc uses ELPA package specifications, which you can also pass to
`package-vc-install':
(package-vc-install '(loopy :url "https://github.com/okamsn/loopy"
:doc "doc/loopy.texi"))
That being said I have found a bug in `package-vc--unpack-1' and
`package-vc--desc->spec' in that it fails to re-locate the
specification. This is a general problem, whenever packages are
installed with a provided specification. One trick might be to also
consult `package-vc-selected-packages', but that wouldn't solve the
issue we have here.
I believe a general fix would involve storing new or custom package
specifications in a user option, which probably cannot be
'package-vc-selected-packages', similarly to
`package-selected-packages'.
It is imaginable that we add support for a special file, sort of like
.elpaignore (say .elpaspec.eld), that could also be used to consult this
file.
> Thank you.
next prev parent reply other threads:[~2023-03-14 15:56 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-03-14 3:13 How to install documentation in sub-directory with Package VC? Okamsn
2023-03-14 15:56 ` Philip Kaludercic [this message]
2023-03-15 9:41 ` Philip Kaludercic
2023-03-16 1:37 ` Okamsn
2023-03-16 8:44 ` Philip Kaludercic
2023-03-28 1:50 ` Okamsn
2023-03-28 7:41 ` Philip Kaludercic
2023-04-02 0:41 ` Okamsn
2023-04-02 5:24 ` Eli Zaretskii
2023-04-05 7:30 ` Philip Kaludercic
2023-04-06 3:52 ` Okamsn
2023-04-06 15:42 ` Philip Kaludercic
2023-04-10 13:39 ` Philip Kaludercic
2023-04-12 0:04 ` Okamsn
2023-04-12 7:27 ` Philip Kaludercic
2023-04-12 7:41 ` Eli Zaretskii
2023-04-12 7:48 ` Philip Kaludercic
2023-04-07 21:46 ` Jonas Bernoulli
2023-04-08 8:36 ` Philip Kaludercic
2023-04-09 18:39 ` Jonas Bernoulli
2023-04-09 20:44 ` Lynn Winebarger
2023-04-09 21:55 ` Philip Kaludercic
2023-03-28 11:48 ` Eli Zaretskii
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=87bkkvconh.fsf@posteo.net \
--to=philipk@posteo.net \
--cc=emacs-devel@gnu.org \
--cc=okamsn@protonmail.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).