Re: [PATCH] org-capture: Update plist before finalizing

[Leo Vivier <zaeph@zaeph.net>]

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

Hi there,

Kyle Meyer <kyle@kyleam.com> writes:

> Thanks for the detailed write-up and the patch (and sorry for the slow
> reply).

No worries, and thanks for the review.

> It'd be good to at least point to the motivation/usecase for this change
> here.  (Your description section above already does a nice job of
> that.)

Done.  I’ve also added a link to this thread.

> Convention nit: please end your comment with a period.

Done.

> Perhaps add a brief mention of `org-capture-after-finalize' (or some
> other hint of why) here.

I’ve added some details to bridge the gap with the docstring for
`org-capture-current-plist'.

You’ll find the amended commit below.

Best,

-- 
Leo Vivier
Freelance Software Engineer
Website: www.leovivier.com | Blog: www.zaeph.net

[-- Attachment #2: 0001-org-capture-Update-plist-before-finalizing.patch --]
[-- Type: text/x-patch, Size: 1942 bytes --]

From ab47e50dae4029622d3e8378f816f77153c180d9 Mon Sep 17 00:00:00 2001
From: Leo Vivier <zaeph@zaeph.net>
Date: Sat, 25 Jul 2020 21:53:07 +0200
Subject: [PATCH] org-capture: Update plist before finalizing
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* lisp/org-capture.el (org-capture-finalize): Update
`org-capture-plist' with local-value before finalizing.

We use the global-variable `org-capture-plist' to populate the
local-variable `org-capture-current-plist' on the init of the
`org-capture' buffer.  However, we do not do the opposite (i.e. update
the global-variable with the local-variable) on
`org-capture-finalize'.

This is fine for the majority of `org-capture-finalize', since we’re
using the LOCAL arg of `org-capture-get' to read
`org-capture-current-plist' instead of `org-capture-list', but this
trick does not work for `org-capture-after-finalize', since the hook
is run after the `org-capture-buffer' has been closed.

This causes problem with `:kill-buffer t', and it limits what can be
done with cleanup functions in `org-capture-after-finalize'.

See <https://orgmode.org/list/87h7tv9pkm.fsf@hidden/> for details.
---
 lisp/org-capture.el | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/lisp/org-capture.el b/lisp/org-capture.el
index 0ca75c772..b74978c82 100644
--- a/lisp/org-capture.el
+++ b/lisp/org-capture.el
@@ -735,6 +735,11 @@ captured item after finalizing."
 
   (run-hooks 'org-capture-prepare-finalize-hook)
 
+  ;; Update `org-capture-plist' with the buffer-local value.  Since
+  ;; captures can be run concurrently, this is to ensure that
+  ;; `org-capture-after-finalize-hook' accesses the proper plist.
+  (setq org-capture-plist org-capture-current-plist)
+
   ;; Did we start the clock in this capture buffer?
   (when (and org-capture-clock-was-started
 	     org-clock-marker
-- 
2.28.0