Daniel Clemente <n142...@gmail.com> writes: >> Nope. "org-persist" directory is not only used by org-element. If some >> other parts of Org need to cache something, they can also store cache >> there. >> > What's the setting then to disable org-persist? I.e. to disable > creating of files like ~/.cache/org-persist/gc-lock.eld > Many people seem to want to disable all creation of org-mode related files.
It is impossible. We need to store files like latex previews somewhere. This somewhere is org-persist-directory now. That said, gc-lock.eld should not be created when nothing else is actually stored in the cache. It will be fixed. >> May you suggest an alternative docstring? >> > > I don't know org-persist or org-element-cache-persistent so this needs > your input. I can start with a template, and you can fine-tune it, > expand it or rewrite it:... Thanks! I am attaching tentative patch that improve the documentation. I hope that it clarifies things for you.
>From 8a64e83303566bad608c386fbdafe34aa9065a2b Mon Sep 17 00:00:00 2001 Message-ID: <8a64e83303566bad608c386fbdafe34aa9065a2b.1718725818.git.yanta...@posteo.net> From: Ihor Radchenko <yanta...@posteo.net> Date: Tue, 18 Jun 2024 17:49:43 +0200 Subject: [PATCH] org-element-cache: Improve docstrings * lisp/org-element.el (org-element-use-cache): (org-element-cache-persistent): Add more details to the docstrings. Reported-by: Daniel Clemente <n142...@gmail.com> Link: https://orgmode.org/list/CAJKAhPBUAS2bDT5k+xB2E-vu+d==yonafkjdku2hc4qmb_x...@mail.gmail.com --- lisp/org-element.el | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/lisp/org-element.el b/lisp/org-element.el index 191bb5698..631cdf20c 100644 --- a/lisp/org-element.el +++ b/lisp/org-element.el @@ -5744,10 +5744,19 @@ ;;; Cache ;;;###autoload (defvar org-element-use-cache t - "Non-nil when Org parser should cache its results.") + "Non-nil when Org parser should cache its results. +The results are cached in memory and may also be cached between Emacs +sessions if `org-element-cache-persistent' is set to non-nil.") (defvar org-element-cache-persistent t - "Non-nil when cache should persist between Emacs sessions.") + "Non-nil when Org element cache should persist between Emacs sessions. +Cache files are written to disk at `org-persist-directory'. +The cache will be updated when Emacs is closed or when an Org buffer +is closed. + +Persisting the cache to disk can speed up opening Org files +\\(especially large Org files). It is not recommended if the Org files +include sensitive data, unless the data is encrypted via `org-crypt'.") (defconst org-element-cache-version "2.3" "Version number for Org AST structure. -- 2.45.1
> My own experience, very subjective and it may be an edge case, is that > enabling org-element-cache-persistent didn't make loading my org files > faster; on the contrary, it made some things slower (including closing > Emacs). What happens if you set `org-persist--report-time' to t in your config and examine *Messages* buffer after opening/closing some Org files? Look for "org-persist:..." messages. -- 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>
