From 8a64e83303566bad608c386fbdafe34aa9065a2b Mon Sep 17 00:00:00 2001 Message-ID: <8a64e83303566bad608c386fbdafe34aa9065a2b.1718725818.git.yantar92@posteo.net> From: Ihor Radchenko 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 Link: https://orgmode.org/list/CAJKAhPBUAS2bDT5k+xB2E-vu+d==yoNAfKjdKu2HC4qmB_XUnw@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