From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Joseph Turner via "Bug reports for GNU Emacs, the Swiss army knife of text editors" Newsgroups: gmane.emacs.bugs Subject: bug#63337: [PATCH] package-vc--build-documentation: Fix relative @include statements Date: Sun, 07 May 2023 11:40:46 -0700 Message-ID: <87pm7c7zfs.fsf@breatheoutbreathe.in> References: <87fs89qg9y.fsf@breatheoutbreathe.in> <87cz3cea4k.fsf@posteo.net> Reply-To: Joseph Turner Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="16405"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 63337@debbugs.gnu.org To: Philip Kaludercic Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun May 07 20:46:23 2023 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1pvjOo-00047B-Hy for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 07 May 2023 20:46:23 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pvjOg-0007Yf-Uz; Sun, 07 May 2023 14:46:15 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pvjOW-0007WN-3q for bug-gnu-emacs@gnu.org; Sun, 07 May 2023 14:46:04 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pvjOU-0008Fc-BA for bug-gnu-emacs@gnu.org; Sun, 07 May 2023 14:46:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pvjOU-0000Bt-4S for bug-gnu-emacs@gnu.org; Sun, 07 May 2023 14:46:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Joseph Turner Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 07 May 2023 18:46:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 63337 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 63337-submit@debbugs.gnu.org id=B63337.1683485156710 (code B ref 63337); Sun, 07 May 2023 18:46:02 +0000 Original-Received: (at 63337) by debbugs.gnu.org; 7 May 2023 18:45:56 +0000 Original-Received: from localhost ([127.0.0.1]:38488 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pvjON-0000BL-L7 for submit@debbugs.gnu.org; Sun, 07 May 2023 14:45:56 -0400 Original-Received: from out-5.mta1.migadu.com ([95.215.58.5]:43018) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pvjOK-0000BC-QX for 63337@debbugs.gnu.org; Sun, 07 May 2023 14:45:54 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=breatheoutbreathe.in; s=key1; t=1683485151; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=7dcsEc9gu/y/l3RjELh3iakGGV7as6jDSieAGaLohD8=; b=jzTSRsKZMb78W+h0t5GmYFVEhG3LZPIPkqz4o1Im+Sx69CPnE2V1t95jOOlcv9zAO5xqmJ ajH4aI+V22rIUkYtVLhaWXa7neOSBVeVvGp+dtiqoJTMqs2yFnULL7JBFLA2q+25gzF8fF gNXr7GUSCDFy8KvUtDcwx84nHypY3pg= X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. In-reply-to: <87cz3cea4k.fsf@posteo.net> X-Migadu-Flow: FLOW_OUT X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:261272 Archived-At: --=-=-= Content-Type: text/plain Philip Kaludercic writes: > Joseph Turner writes: > >> Hello! >> >> Because package-vc--build-documentation exports the texinfo manual to a >> temp file inside /tmp/ , any @include statements with relative paths >> break the makeinfo call. >> >> I noticed this issue when attempting to use package-vc to install >> org-transclusion, whose manual contains the line >> >> #+texinfo: @include fdl.texi >> >> See: https://raw.githubusercontent.com/nobiot/org-transclusion/main/docs/org-transclusion-manual.org >> >> The attached patch solves this problem by passing the -I flag to >> makeinfo. From makeinfo --help: >> >> -I DIR append DIR to the @include search path. > > Good catch, this should be applied to emacs-29. > >> Best, >> >> Joseph >> >> From a41abce88ed3b833c5531208945474c9cd16284b Mon Sep 17 00:00:00 2001 >> From: Joseph Turner >> Date: Sat, 6 May 2023 14:49:43 -0700 >> Subject: [PATCH] Fix: (package-vc--build-documentation) Relative @include >> statements >> >> --- >> lisp/emacs-lisp/package-vc.el | 5 ++++- >> 1 file changed, 4 insertions(+), 1 deletion(-) >> >> diff --git a/lisp/emacs-lisp/package-vc.el b/lisp/emacs-lisp/package-vc.el >> index 489610e2a1e..63c10285ca7 100644 >> --- a/lisp/emacs-lisp/package-vc.el >> +++ b/lisp/emacs-lisp/package-vc.el >> @@ -381,6 +381,7 @@ FILE can be an Org file, indicated by its \".org\" extension, >> otherwise it's assumed to be an Info file." >> (let* ((pkg-name (package-desc-name pkg-desc)) >> (default-directory (package-desc-dir pkg-desc)) >> + (docs-directory (expand-file-name (file-name-directory file))) >> (output (expand-file-name (format "%s.info" pkg-name))) >> clean-up) >> (when (string-match-p "\\.org\\'" file) >> @@ -395,7 +396,9 @@ otherwise it's assumed to be an Info file." >> (erase-buffer) >> (cond >> ((/= 0 (call-process "makeinfo" nil t nil >> - "--no-split" file "-o" output)) >> + "-I" docs-directory > > According to the docs, makeinfo has -I to append the search path, and -P > to prepend. I don't know how well either of the two are supported, but > assuming they are, shouldn't -P be preferred? Or wouldn't it have any > effect? I am not sure what difference it would make. I don't know if the default @include search path includes anything besides the working directory. In the attached diff, I have changed -I to -P. >> + "--no-split" file >> + "-o" output)) >> (message "Failed to build manual %s, see buffer %S" >> file (buffer-name))) >> ((/= 0 (call-process "install-info" nil t nil --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-Fix-package-vc-build-documentation-Relative-include-.patch >From a41abce88ed3b833c5531208945474c9cd16284b Mon Sep 17 00:00:00 2001 From: Joseph Turner Date: Sat, 6 May 2023 14:49:43 -0700 Subject: [PATCH] Fix: (package-vc--build-documentation) Relative @include statements --- lisp/emacs-lisp/package-vc.el | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/lisp/emacs-lisp/package-vc.el b/lisp/emacs-lisp/package-vc.el index 489610e2a1e..63c10285ca7 100644 --- a/lisp/emacs-lisp/package-vc.el +++ b/lisp/emacs-lisp/package-vc.el @@ -381,6 +381,7 @@ FILE can be an Org file, indicated by its \".org\" extension, otherwise it's assumed to be an Info file." (let* ((pkg-name (package-desc-name pkg-desc)) (default-directory (package-desc-dir pkg-desc)) + (docs-directory (expand-file-name (file-name-directory file))) (output (expand-file-name (format "%s.info" pkg-name))) clean-up) (when (string-match-p "\\.org\\'" file) @@ -395,7 +396,9 @@ otherwise it's assumed to be an Info file." (erase-buffer) (cond ((/= 0 (call-process "makeinfo" nil t nil - "--no-split" file "-o" output)) + "-P" docs-directory + "--no-split" file + "-o" output)) (message "Failed to build manual %s, see buffer %S" file (buffer-name))) ((/= 0 (call-process "install-info" nil t nil -- 2.39.2 --=-=-=--