From: Ihor Radchenko <yantar92@posteo.net>
To: Kaushal Modi <kaushal.modi@gmail.com>
Cc: emacs-org list <emacs-orgmode@gnu.org>,
Nicolas Goaziou <mail@nicolasgoaziou.fr>
Subject: Re: Possible bug in `org-subtree--get-subtree-options`?
Date: Tue, 18 Oct 2022 04:12:04 +0000 [thread overview]
Message-ID: <87pmephisr.fsf@localhost> (raw)
In-Reply-To: <CAFyQvY3mxi4DRTS+W-AX7bFELVujqH4DODEYPy3hyGRRuMEPSw@mail.gmail.com>
[-- Attachment #1: Type: text/plain, Size: 1317 bytes --]
Kaushal Modi <kaushal.modi@gmail.com> writes:
> Today I was debugging something where a subtree export wasn't recognizing
> the EXPORT_OPTIONS property set in that subtree.
>
> MWE:
>
> =====
> * Top level
> ** Allow broken links, but mark them
> :PROPERTIES:
> :EXPORT_FILE_NAME: allow-broken-links-but-mark-them
> :EXPORT_OPTIONS: broken-links:mark
> :END:
> =====
>
> 1. Move cursor to BOL of "** Allow broken links, but mark them" line.
> 2. M-: (org-export--get-subtree-options)
>
> Output:
>
> (:title (#("Top level" 0 9 (:parent #1))))
>
> Issue: Point is already on a heading, but it is jumping to the parent
> heading and returning that heading's properties.
>
> Debugging through how the export options got parsed in subtree exports, I
> reached the `org-export--get-subtree-options' function and this line in
> there:
>
> ;;
> https://git.savannah.gnu.org/cgit/emacs/org-mode.git/tree/lisp/ox.el#n1425
> (if (org-at-heading-p) (org-up-heading-safe) (org-back-to-heading t))
>
> It looks like the if condition actions are swapped here.
Not really swapped. A simple (org-back-to-heading t) will probably be
enough. See the attached patch.
However, I am concerned that one of the tests is actually assuming that
current subtree in the below example includes "Heading".
* Heading
** Child
** Child<point>
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-org-export-get-subtree-options-Do-not-jump-to-parent.patch --]
[-- Type: text/x-patch, Size: 1941 bytes --]
From e2c1dc3955eb54cee7ce137d548c687e378f4c8a Mon Sep 17 00:00:00 2001
Message-Id: <e2c1dc3955eb54cee7ce137d548c687e378f4c8a.1666066170.git.yantar92@posteo.net>
From: Ihor Radchenko <yantar92@posteo.net>
Date: Tue, 18 Oct 2022 12:07:37 +0800
Subject: [PATCH] org-export--get-subtree-options: Do not jump to parent
subtree
* lisp/ox.el: Never jump to parent heading even when point is at an
existing heading.
* testing/lisp/test-ox.el (test-org-export/get-subtree-options): Fix
test assuming that current subtree may include parent.
Reported-by: Kaushal Modi <kaushal.modi@gmail.com>
Link: https://orgmode.org/list/CAFyQvY3mxi4DRTS+W-AX7bFELVujqH4DODEYPy3hyGRRuMEPSw@mail.gmail.com
---
lisp/ox.el | 2 +-
testing/lisp/test-ox.el | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/lisp/ox.el b/lisp/ox.el
index 92f6010a0..9f44ec3ef 100644
--- a/lisp/ox.el
+++ b/lisp/ox.el
@@ -1434,7 +1434,7 @@ (defun org-export--get-subtree-options (&optional backend)
;; property is the keyword with "EXPORT_" appended to it.
(org-with-wide-buffer
;; Make sure point is at a heading.
- (if (org-at-heading-p) (org-up-heading-safe) (org-back-to-heading t))
+ (org-back-to-heading t)
(let ((plist
;; EXPORT_OPTIONS are parsed in a non-standard way. Take
;; care of them right from the start.
diff --git a/testing/lisp/test-ox.el b/testing/lisp/test-ox.el
index 42867919b..0d39160b6 100644
--- a/testing/lisp/test-ox.el
+++ b/testing/lisp/test-ox.el
@@ -388,7 +388,7 @@ (ert-deftest test-org-export/get-subtree-options ()
(plist-get (org-export-get-environment nil t) :date))))
;; Still grab correct options when section above is empty.
(should
- (equal '("H1")
+ (equal '("H12")
(org-test-with-temp-text "* H1\n** H11\n** H12<point>"
(plist-get (org-export-get-environment nil t) :title))))
;; More than one property can refer to the same node property.
--
2.35.1
[-- Attachment #3: Type: text/plain, Size: 224 bytes --]
--
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>
next prev parent reply other threads:[~2022-10-18 4:12 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-03-14 17:42 Possible bug in `org-subtree--get-subtree-options`? Kaushal Modi
2022-10-18 4:12 ` Ihor Radchenko [this message]
2022-11-27 8:51 ` Ihor Radchenko
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.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87pmephisr.fsf@localhost \
--to=yantar92@posteo.net \
--cc=emacs-orgmode@gnu.org \
--cc=kaushal.modi@gmail.com \
--cc=mail@nicolasgoaziou.fr \
/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/org-mode.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).