unofficial mirror of help-gnu-emacs@gnu.org
 help / color / mirror / Atom feed
From: Philip Kaludercic <philipk@posteo.net>
To: Joseph Turner <joseph@breatheoutbreathe.in>
Cc: help-gnu-emacs@gnu.org,  Ruijie Yu <ruijie@netyu.xyz>
Subject: Re: package-vc-install fails to build docs
Date: Sat, 22 Apr 2023 07:27:49 +0000	[thread overview]
Message-ID: <871qkcl6kq.fsf@posteo.net> (raw)
In-Reply-To: <sdvedocwipo.fsf@netyu.xyz> (Ruijie Yu via Users list for the's message of "Sat, 22 Apr 2023 14:07:15 +0800")

Ruijie Yu via Users list for the GNU Emacs text editor
<help-gnu-emacs@gnu.org> writes:

> Joseph Turner <joseph@breatheoutbreathe.in> writes:
>
>> Hello!
>>
>> With emacs -Q, package-vc-install fails to install the manual for
>> org-transclusion as described here:
>>
>> https://github.com/nobiot/org-transclusion/issues/182
>>
>> I attempted to fix the issue by renaming the manual file from
>> docs/org-transclusion-manual.org -> docs/org-transclusion.org
>> but the problem persists.
>>
>> Can anyone else reproduce this issue?
>
> I'm looking at the package-vc source code, and it doesn't seem to try to
> autodetect any doc files at the moment.  Try adding `:doc` in your
> `package-vc-install' call and see if anything changes.

Right, if you just pass a URL, then package-vc has no metadata.  But
since org-transclusion is on ELPA, you can invoke it like this:

  (package-vc-install 'org-transclusion)

then it should re-use the package specification that GNU ELPA provides.
If you invoke package-vc-install interactively, it would also prompt you
with this package name.

That being said, I just tried it out and it seems that it still doesn't
work because of a discrepancy between the package specification on ELPA
that mentions docs/org-transclusion.org to be the documentation file

 (org-transclusion	:url "https://github.com/nobiot/org-transclusion"
  :make "org-transclusion.org"
  :doc "docs/org-transclusion.org"
  :readme "README.org")

and as you say the fact that the actual manual lies in
docs/org-transclusion-manual.org.  But this is an issue that should
either be fixed in ELPA if the maintainer wishes this file to be used,
or upstream if this is a mistake.

> I'm on recent master, what is your Emacs version?
>
> In GNU Emacs 30.0.50 (build 1, x86_64-pc-linux-gnu, GTK+ Version
>  3.24.37, cairo version 1.17.8) of 2023-03-25 built on ruijie
> Repository revision: db7e95531ac36ae842787b6c5f2859d0642c78cc
> Repository branch: makepkg
> System Description: Arch Linux

-- 
Philip Kaludercic



  reply	other threads:[~2023-04-22  7:27 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-04-22  5:34 package-vc-install fails to build docs Joseph Turner
2023-04-22  6:07 ` Ruijie Yu via Users list for the GNU Emacs text editor
2023-04-22  7:27   ` Philip Kaludercic [this message]
2023-04-22 22:56     ` Joseph Turner
2023-04-23 12:37       ` Philip Kaludercic
2023-04-23 16:54         ` Joseph Turner
2023-04-23 18:36           ` Philip Kaludercic
2023-04-23 20:20             ` Joseph Turner
2023-04-24  5:54               ` Philip Kaludercic
2023-04-28 19:42                 ` Joseph Turner
2023-04-28 21:17                   ` 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=871qkcl6kq.fsf@posteo.net \
    --to=philipk@posteo.net \
    --cc=help-gnu-emacs@gnu.org \
    --cc=joseph@breatheoutbreathe.in \
    --cc=ruijie@netyu.xyz \
    /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.
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).