Short description: When called first imenu does not correctly process an
org-mode file. With the file's buffer killed and reloaded or with any
other org-mode-file after the first take, imenu works correctly.
How to reproduce: Start emacs -q and load an org-mode file (example file
below but any would do).
Enter M-x imenu. When pressing TAB to see the available options every
header is starred like in the orgmode file. *Rescan* does not change the
situation.
Alternatively: enter M-x imenu-add-menubar-index. Menu appears. Opening
it reveals that the stars of the headers have been preserved. Again,
*Rescan* does not change the situation.
Kill the buffer with M-x kill-buffer and reload file.
Enter M-x imenu-add-menubar-index or M-x imenu again. This time
everything seems ok, the stars at the beginning of the headlines are
gone, subheadings have been moved to submenus in the menu.
Expected behavior: Imenu working with org-mode files on the first go
without killing and reopening the org-buffer first.
Notes:
+ Some years ago this behavior was already discovered but I could find
no clarification of the issue:
https://www.reddit.com/r/emacs/comments/10w75ah/imenu_in_orgmode_stop_parsing_after_a_certain/
+ I have also checked the scenario for other modes (C/*-mode,
Python-mode) where imenu works on the first go.
+ However, outline-mode files seem to show the same behavior as org-mode
files. Difference from org-mode-files: For outline-mode the stars do
*not* go away on the second loading of the file. In other words,
behavior on the first attempt is same, but after that org-files are
treated right, outline-files are not.
+ When loading a second org-mode file and calling imenu or
imenu-add-menubar-index this time imenu will work immediately in the
expected way on that file.
+ Any org-file I tested showed the same problem. Here is a simple one:
* One
** One a
* Two
* Three
* Four
------------------------------------------------------------------------
Emacs : GNU Emacs 29.4 (build 1, x86_64-pc-linux-gnu, GTK+ Version
3.24.43, cairo version 1.18.2)
Package: Org mode version 9.6.15 (release_9.6.15 @
/usr/share/emacs/29.4/lisp/org/)
current state:
==============
(setq
org-link-elisp-confirm-function 'yes-or-no-p
org-bibtex-headline-format-function #[257 "\300\236A\207" [:title] 3
"\n\n(fn ENTRY)"]
org-persist-after-read-hook '(org-element--cache-persist-after-read)
org-export-before-parsing-hook '(org-attach-expand-links)
org-cycle-tab-first-hook '(org-babel-hide-result-toggle-maybe
org-babel-header-arg-expand)
org-archive-hook '(org-attach-archive-delete-maybe)
org-cycle-hook '(org-cycle-hide-archived-subtrees
org-cycle-show-empty-lines
org-cycle-optimize-window-after-visibility-change
org-cycle-display-inline-images)
org-persist-before-read-hook '(org-element--cache-persist-before-read)
org-mode-hook '(#[0 "\300\301\302\303\304$\207"
[add-hook change-major-mode-hook org-fold-show-all append
local]
5]
#[0 "\300\301\302\303\304$\207"
[add-hook change-major-mode-hook org-babel-show-result-all
append local]
5]
org-babel-result-hide-spec org-babel-hide-all-hashes)
org-confirm-shell-link-function 'yes-or-no-p
outline-isearch-open-invisible-function 'outline-isearch-open-invisible
org-agenda-before-write-hook '(org-agenda-add-entry-text)
org-src-mode-hook '(org-src-babel-configure-edit-buffer
org-src-mode-configure-edit-buffer)
org-confirm-elisp-link-function 'yes-or-no-p
org-speed-command-hook '(org-speed-command-activate
org-babel-speed-command-activate)
org-persist-directory "/tmp/org-persist-3j1g7K"
org-fold-core-isearch-open-function 'org-fold--isearch-reveal
org-persist-before-write-hook '(org-element--cache-persist-before-write)
org-tab-first-hook '(org-babel-hide-result-toggle-maybe
org-babel-header-arg-expand)
org-link-shell-confirm-function 'yes-or-no-p
org-babel-pre-tangle-hook '(save-buffer)
org-agenda-loop-over-headlines-in-active-region nil
org-occur-hook '(org-first-headline-recenter)
org-metadown-hook '(org-babel-pop-to-session-maybe)
org-link-parameters '(("attachment" :follow org-attach-follow :complete
org-attach-complete-link)
("id" :follow org-id-open)
("eww" :follow org-eww-open :store org-eww-store-link)
("rmail" :follow org-rmail-open :store
org-rmail-store-link)
("mhe" :follow org-mhe-open :store org-mhe-store-link)
("irc" :follow org-irc-visit :store org-irc-store-link
:export org-irc-export)
("info" :follow org-info-open :export org-info-export
:store org-info-store-link :insert-description
org-info-description-as-command)
("gnus" :follow org-gnus-open :store
org-gnus-store-link)
("docview" :follow org-docview-open :export
org-docview-export :store org-docview-store-link)
("bibtex" :follow org-bibtex-open :store
org-bibtex-store-link)
("bbdb" :follow org-bbdb-open :export org-bbdb-export
:complete org-bbdb-complete-link :store
org-bbdb-store-link)
("w3m" :store org-w3m-store-link)
("doi" :follow org-link-doi-open :export
org-link-doi-export)
("file+sys") ("file+emacs")
("shell" :follow org-link--open-shell)
("news" :follow
#[514 "\301\300\302Q\"\207"
["news" browse-url ":"] 6 "\n\n(fn URL ARG)"]
)
("mailto" :follow
#[514 "\301\300\302Q\"\207"
["mailto" browse-url ":"] 6 "\n\n(fn URL ARG)"]
)
("https" :follow
#[514 "\301\300\302Q\"\207"
["https" browse-url ":"] 6 "\n\n(fn URL ARG)"]
)
("http" :follow
#[514 "\301\300\302Q\"\207"
["http" browse-url ":"] 6 "\n\n(fn URL ARG)"]
)
("ftp" :follow
#[514 "\301\300\302Q\"\207" ["ftp" browse-url ":"]
6 "\n\n(fn URL ARG)"]
)
("help" :follow org-link--open-help :store
org-link--store-help)
("file" :complete org-link-complete-file)
("elisp" :follow org-link--open-elisp))
org-metaup-hook '(org-babel-load-in-session-maybe)
)
