GNU bug report logs - #65243
[PATCH] Fix building of VC package manuals with relative org links/includes

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 65243 in the body.
You can then email your comments to 65243 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Joseph Turner <joseph <at> breatheoutbreathe.in>
To: bug-gnu-emacs <at> gnu.org
Cc: philipk <at> posteo.net
Subject: [PATCH] Fix building of VC package manuals with relative org
 links/includes
Date: Sat, 12 Aug 2023 01:43:35 -0700

[Message part 1 (text/plain, inline)]

Hello,

This patch allows for relative includes and link in org files compiled
to texinfo.

Unfortunately, I missed this back in May
(commit 1e6a7594 ), when we fixed relative texi @include links.

I'm not sure how the Emacs release cycle works. Would it be possible to
include this fix in 29.2?

Best,

Joseph

[0001-Fix-building-of-VC-package-manuals-with-relative-org.patch (text/x-diff, attachment)]

Message #8 received at 65243 <at> debbugs.gnu.org (full text, mbox):

From: Philip Kaludercic <philipk <at> posteo.net>
To: Joseph Turner <joseph <at> breatheoutbreathe.in>
Cc: 65243 <at> debbugs.gnu.org
Subject: Re: bug#65243: [PATCH] Fix building of VC package manuals with
 relative org links/includes
Date: Mon, 14 Aug 2023 08:14:31 +0000

Joseph Turner <joseph <at> breatheoutbreathe.in> writes:

> Hello,
>
> This patch allows for relative includes and link in org files compiled
> to texinfo.
>
> Unfortunately, I missed this back in May
> (commit 1e6a7594 ), when we fixed relative texi @include links.
>
> I'm not sure how the Emacs release cycle works. Would it be possible to
> include this fix in 29.2?

I wouldn't have any issue with that, and AFAIU now that the release has
been cut, this should be fine, as this is just a bug fix.

BTW, what package is this related to?

> Best,
>
> Joseph
>
>>From e951b0ea4ffa90202ecee934eddd895b706c6794 Mon Sep 17 00:00:00 2001
> From: Joseph Turner <joseph <at> breatheoutbreathe.in>
> Date: Sat, 12 Aug 2023 01:40:07 -0700
> Subject: [PATCH] Fix building of VC package manuals with relative org
>  links/includes
>
> * lisp/emacs-lisp/package-vc.el (package-vc--build-documentation):
> Ensure that default-default is the docs-directory around
> org-export-to-file to ensure that links to relative files work correctly.
> ---
>  lisp/emacs-lisp/package-vc.el | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/lisp/emacs-lisp/package-vc.el b/lisp/emacs-lisp/package-vc.el
> index b4c911015b5..ffc7afeb2ee 100644
> --- a/lisp/emacs-lisp/package-vc.el
> +++ b/lisp/emacs-lisp/package-vc.el
> @@ -356,7 +356,8 @@ otherwise it's assumed to be an Info file."
>        (with-temp-buffer
>          (insert-file-contents file)
>          (setq file (make-temp-file "ox-texinfo-"))
> -        (org-export-to-file 'texinfo file)
> +        (let ((default-directory docs-directory))
> +          (org-export-to-file 'texinfo file))
>          (setq clean-up t)))
>      (with-current-buffer (get-buffer-create " *package-vc doc*")
>        (erase-buffer)

Message #11 received at 65243 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Philip Kaludercic <philipk <at> posteo.net>
Cc: 65243 <at> debbugs.gnu.org, joseph <at> breatheoutbreathe.in
Subject: Re: bug#65243: [PATCH] Fix building of VC package manuals with
 relative org links/includes
Date: Mon, 14 Aug 2023 15:11:00 +0300

> Cc: 65243 <at> debbugs.gnu.org
> From: Philip Kaludercic <philipk <at> posteo.net>
> Date: Mon, 14 Aug 2023 08:14:31 +0000
> 
> Joseph Turner <joseph <at> breatheoutbreathe.in> writes:
> 
> > I'm not sure how the Emacs release cycle works. Would it be possible to
> > include this fix in 29.2?
> 
> I wouldn't have any issue with that, and AFAIU now that the release has
> been cut, this should be fine, as this is just a bug fix.

Fine by me, thanks.

Message #14 received at 65243 <at> debbugs.gnu.org (full text, mbox):

From: Joseph Turner <joseph <at> breatheoutbreathe.in>
To: Philip Kaludercic <philipk <at> posteo.net>
Cc: 65243 <at> debbugs.gnu.org
Subject: Re: bug#65243: [PATCH] Fix building of VC package manuals with
 relative org links/includes
Date: Mon, 14 Aug 2023 18:57:20 -0700

Philip Kaludercic <philipk <at> posteo.net> writes:

> Joseph Turner <joseph <at> breatheoutbreathe.in> writes:
>
>> Hello,
>>
>> This patch allows for relative includes and link in org files compiled
>> to texinfo.
>
> BTW, what package is this related to?

On my machine,

(package-vc-install '(hyperdrive
                      :url "https://git.sr.ht/~ushin/hyperdrive.el"
                      :doc "doc/hyperdrive-manual.org"))

gives the following backtrace:

Debugger entered--Lisp error: (error "Cannot include file /home/joseph/.emacs.d/elpa/hyperdrive/fdl.org")
  error("Cannot include file %s" "/home/joseph/.emacs.d/elpa/hyperdrive/fdl.org")
  org-export-expand-include-keyword()
  org-export-as(texinfo nil nil nil (:output-file "/tmp/ox-texinfo-hqSZfl"))
  org-export-to-file(texinfo "/tmp/ox-texinfo-hqSZfl")
  package-vc--build-documentation(#s(package-desc :name hyperdrive :version nil :summary "No description available." :reqs nil :kind vc :archive nil :dir "/home/joseph/.emacs.d/elpa/hyperdrive/" :extras nil :signed nil) "doc/hyperdrive-manual.org")
  package-vc--unpack-1(#s(package-desc :name hyperdrive :version nil :summary "No description available." :reqs nil :kind vc :archive nil :dir "/home/joseph/.emacs.d/elpa/hyperdrive/" :extras nil :signed nil) "/home/joseph/.emacs.d/elpa/hyperdrive/")
  package-vc--unpack(#s(package-desc :name hyperdrive :version nil :summary "No description available." :reqs nil :kind vc :archive nil :dir "/home/joseph/.emacs.d/elpa/hyperdrive/" :extras nil :signed nil) (:url "https://git.sr.ht/~ushin/hyperdrive.el" :doc "doc/hyperdrive-manual.org") nil)
  package-vc-install((hyperdrive :url "https://git.sr.ht/~ushin/hyperdrive.el" :doc "doc/hyperdrive-manual.org"))

"/home/joseph/.emacs.d/elpa/hyperdrive/fdl.org" does not exist, but
"/home/joseph/.emacs.d/elpa/hyperdrive/doc/fdl.org" does.

Hope this helps!

Joseph

Message #19 received at 65243-done <at> debbugs.gnu.org (full text, mbox):

From: Philip Kaludercic <philipk <at> posteo.net>
To: Joseph Turner <joseph <at> breatheoutbreathe.in>
Cc: 65243-done <at> debbugs.gnu.org
Subject: Re: bug#65243: [PATCH] Fix building of VC package manuals with
 relative org links/includes
Date: Sat, 19 Aug 2023 09:46:29 +0000

Joseph Turner <joseph <at> breatheoutbreathe.in> writes:

> Hello,
>
> This patch allows for relative includes and link in org files compiled
> to texinfo.
>
> Unfortunately, I missed this back in May
> (commit 1e6a7594 ), when we fixed relative texi @include links.
>
> I'm not sure how the Emacs release cycle works. Would it be possible to
> include this fix in 29.2?

I have applies the patch to emacs-29, and will close the report.  Thanks!

> Best,
>
> Joseph

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.