mirrors/org-mode
0
0
Fork 1
mirror of https://git.savannah.gnu.org/git/emacs/org-mode.git synced 2024-09-04 21:43:28 +00:00
Code Releases Activity

org-export-copy-buffer: Document the caveats

Browse source 
* lisp/ox.el (org-export-copy-buffer): Mention that `buffer-file-name'
is copied around and explain the consequences.  Document why
`buffer-file-name' is copied.
This commit is contained in:
Ihor Radchenko 2022-10-07 18:03:18 +08:00
parent 3de74bbeff
commit 17708ab3fa
No known key found for this signature in database
GPG key ID: 6470762A7DA11D8B
1 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
lisp/ox.el
View file

@ -2551,6 +2551,16 @@ Return the updated communication channel."
The copy preserves Org buffer-local variables, visibility and
narrowing.
IMPORTANT: The buffer copy may also have `buffer-file-name' copied.
To prevent Emacs overwriting the original buffer file,
`write-contents-functions' is set to (always). Do not alter this
variable and do not do anything that might alter it (like calling a
major mode) to prevent data corruption. Also, do note that Emacs may
jump into the created buffer if the original file buffer is closed and
then re-opened. Making edits in the buffer copy may also trigger
Emacs save dialogue. Prefer using `org-export-with-buffer-copy' macro
when possible.
When optional argument BUFFER is non-nil, copy into BUFFER.
Optional arguments DROP-VISIBILITY, DROP-NARROWING, DROP-CONTENTS, and
@ -2630,6 +2640,10 @@ The function assumes BUFFER's major mode is `org-mode'."
(and (not (memq var org-export-ignored-local-variables))
(or (memq var
'(default-directory
;; Required to convert file
;; links in the #+INCLUDEd
;; files. See
;; `org-export--prepare-file-contents'.
buffer-file-name
buffer-file-coding-system
;; Needed to preserve folding state