Bug: Symlink handling in org-babel-load-file

Bug: Symlink handling in org-babel-load-file

[Ricky Saurav]

[-- Attachment #1: Type: text/plain, Size: 5675 bytes --]

The org-babel-load-file behavior for symlinks seems to have changed
between org-9.1.5(emacs 26.3) and org-9.3(emacs 27.0.6).

The change seems to be that org-9.3 gets the modification time for the
file, which org-9.1.5 resolves the file in case the orginial file is a
symlink before doing the same.

My literate config.org and init.el are located at ~/dotfiles/emacs/.emacs.d/
config.org
and ~/dotfiles/emacs/.emacs.d/init.el respectively.
The above files are then symlinked to ~/.emacs.d using stow.
The tangled file for ~/.emacs.d/config.org is then located at
~/.emacs.d/config.el (this file is not a symlink).

What did I do?
Changed ~/.emacs.d/config.org and restarted emacs.

What did I expect to happen?
Expect tangled ~/.emacs.d/config.el to be updated with the new
changed and loaded as was the case in org-9.1.5(emacs 26.3)

What happened instead?
The file ~/.emacs.d/config.el was not updated and the old file was
loaded. This happens because in org-9.3,the tangled ~/.emacs.d/config.el is
always
newer than the symlink ~/.emacs.d/config.org despite the fact that the
resolved file  ~/dotfiles/emacs/.emacs.d/config.org has been changed.


Remember to cover the basics, that is, what you expected to happen and
what in fact did happen.  You don't know how to make a good report?  See

     https://orgmode.org/manual/Feedback.html#Feedback

Your bug report will be posted to the Org mailing list.
------------------------------------------------------------------------



Emacs  : GNU Emacs 27.0.60 (build 3, x86_64-pc-linux-gnu, GTK+ Version
3.24.13)
 of 2020-01-19
Package: Org mode version 9.3 (release_9.3 @
/home/ricky_saurav/repos/emacs/build/share/emacs/27.0.60/lisp/org/)

current state:
==============
(setq
 org-src-mode-hook '(org-src-babel-configure-edit-buffer
org-src-mode-configure-edit-buffer)
 org-link-shell-confirm-function 'yes-or-no-p
 org-metadown-hook '(org-babel-pop-to-session-maybe)
 org-clock-out-hook '(org-clock-remove-empty-clock-drawer)
 org-html-format-inlinetask-function
'org-html-format-inlinetask-default-function
 org-odt-format-headline-function 'org-odt-format-headline-default-function
 org-agenda-files '("~/orgfiles/agenda/schedule.org")
 org-ascii-format-inlinetask-function 'org-ascii-format-inlinetask-default
 org-mode-hook '(org-bullets-mode
#[0 "\301\211 \207"
  [imenu-create-index-function org-imenu-get-tree] 2]
auto-fill-mode
#[0 "\300\301\302\303\304$\207"
  [add-hook change-major-mode-hook org-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-odt-format-drawer-function #[514 "\207" [] 3 "\n\n(fn NAME CONTENTS)"]
 org-archive-hook '(org-attach-archive-delete-maybe)
 org-confirm-elisp-link-function 'yes-or-no-p
 org-agenda-before-write-hook '(org-agenda-add-entry-text)
 org-metaup-hook '(org-babel-load-in-session-maybe)
 org-bibtex-headline-format-function #[257 "\300 \236A\207" [:title] 3
"\n\n(fn ENTRY)"]
 org-latex-format-drawer-function #[514 "\207" [] 3 "\n\n(fn _ CONTENTS)"]
 org-babel-pre-tangle-hook '(save-buffer)
 org-tab-first-hook '(org-babel-hide-result-toggle-maybe
org-babel-header-arg-expand)
 org-ascii-format-drawer-function #[771 " \207" [] 4 "\n\n(fn NAME CONTENTS
WIDTH)"]
 org-occur-hook '(org-first-headline-recenter)
 org-cycle-hook '(org-cycle-hide-archived-subtrees
org-cycle-show-empty-lines
 org-optimize-window-after-visibility-change)
 org-speed-command-hook '(org-speed-command-activate
 org-babel-speed-command-activate)
 org-odt-format-inlinetask-function
'org-odt-format-inlinetask-default-function
 org-confirm-shell-link-function 'yes-or-no-p
 org-link-parameters '(("attachment" :follow org-attach-open-link :export
org-attach-export-link :complete org-attach-complete-link)
  ("id" :follow org-id-open)
  ("eww" :follow eww :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)
  ("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)
  ("treemacs" :store treemacs-store-org-link) ("file+sys")
  ("file+emacs") ("shell" :follow org-link--open-shell)
  ("news" :follow
#[257 "\301\300\302 Q!\207" ["news" browse-url ":"] 5
 "\n\n(fn URL)"]
)
  ("mailto" :follow
#[257 "\301\300\302 Q!\207" ["mailto" browse-url ":"] 5
 "\n\n(fn URL)"]
)
  ("https" :follow
#[257 "\301\300\302 Q!\207" ["https" browse-url ":"] 5
 "\n\n(fn URL)"]
)
  ("http" :follow
#[257 "\301\300\302 Q!\207" ["http" browse-url ":"] 5
 "\n\n(fn URL)"]
)
  ("ftp" :follow
#[257 "\301\300\302 Q!\207" ["ftp" browse-url ":"] 5
 "\n\n(fn URL)"]
)
  ("help" :follow org-link--open-help)
  ("file" :complete org-link-complete-file)
  ("elisp" :follow org-link--open-elisp)
  ("doi" :follow org-link--open-doi))
 org-latex-format-headline-function
'org-latex-format-headline-default-function
 org-link-elisp-confirm-function 'yes-or-no-p
 org-latex-format-inlinetask-function
'org-latex-format-inlinetask-default-function
 org-html-format-drawer-function #[514 "\207" [] 3 "\n\n(fn NAME CONTENTS)"]
 org-html-format-headline-function
'org-html-format-headline-default-function
 )

[-- Attachment #2: Type: text/html, Size: 7480 bytes --]

Re: Bug: Symlink handling in org-babel-load-file

[Bastien]

[-- Attachment #1: Type: text/plain, Size: 97 bytes --]

Hi Ricky,

thanks for reporting this.

Can you try this patch and confirm it solves your issue?


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: org.el.patch --]
[-- Type: text/x-diff, Size: 628 bytes --]

diff --git a/lisp/org.el b/lisp/org.el
index f3823284c..ef2c7b9e6 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -218,7 +218,8 @@ and then loads the resulting file using `load-file'.  With
 optional prefix argument COMPILE, the tangled Emacs Lisp file is
 byte-compiled before it is loaded."
   (interactive "fFile to load: \nP")
-  (let* ((tangled-file (concat (file-name-sans-extension file) ".el")))
+  (let* ((file (file-truename file))
+	 (tangled-file (concat (file-name-sans-extension file) ".el")))
     ;; Tangle only if the Org file is newer than the Elisp file.
     (unless (org-file-newer-than-p
 	     tangled-file

[-- Attachment #3: Type: text/plain, Size: 14 bytes --]


-- 
 Bastien

Re: Bug: Symlink handling in org-babel-load-file

[ricky saurav]

[-- Attachment #1.1: Type: text/plain, Size: 738 bytes --]

Hey Bastien,
After this patch, org-mode loads the most updated config. A minor issue
that I have is that this patch creates config.el in my dotfiles directory,
instead of ~/.emacs.d/config.el ,since ~/.emacs.d/config.org is a symlink
to ~/dotfiles/config.org. The behaviour in org-9.1.5(emacs 26.3), was
resolution of symlinks for just fetching the file
attributes(file-modification-time). The below patch summarizes the changes
that would keep the current version in line with current version in emacs
release  org-9.1.5(emacs 26.3).
Regards,
Saurav

On Wed, 12 Feb 2020 at 17:40, Bastien <bzg@gnu.org> wrote:

> Hi Ricky,
>
> thanks for reporting this.
>
> Can you try this patch and confirm it solves your issue?
>
>
> --
>  Bastien
>

[-- Attachment #1.2: Type: text/html, Size: 1156 bytes --]

[-- Attachment #2: org-babel-load-file.patch --]
[-- Type: text/x-patch, Size: 875 bytes --]

diff --git a/lisp/org.el b/lisp/org.el
index 1a995cc40..239e3528f 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -218,12 +218,11 @@ and then loads the resulting file using `load-file'.  With
 optional prefix argument COMPILE, the tangled Emacs Lisp file is
 byte-compiled before it is loaded."
   (interactive "fFile to load: \nP")
-  (let* ((file (file-truename file))
-	 (tangled-file (concat (file-name-sans-extension file) ".el")))
+  (let* ((tangled-file (concat (file-name-sans-extension file) ".el")))
     ;; Tangle only if the Org file is newer than the Elisp file.
     (unless (org-file-newer-than-p
 	     tangled-file
-	     (file-attribute-modification-time (file-attributes file)))
+	     (file-attribute-modification-time (file-attributes (file-truename file))))
       (org-babel-tangle-file file tangled-file "emacs-lisp\\|elisp"))
     (if compile
 	(progn

Re: Bug: Symlink handling in org-babel-load-file

[Bastien]

Hi Ricky,

thanks for the double-check, I've now apply the change as you suggest.

Best,

-- 
 Bastien