Browse Source

org-export-babel-evaluate docstring expanded.

* lisp/ob-exp.el (org-export-babel-evaluate); Inform users that `:eval
  never-export' should be used to avoid rerunning code on export.
  Some users are puzzled when setting this variable to `nil' disables
  all of babel.

The issue was raised by Ken Mankoff:
http://article.gmane.org/gmane.emacs.orgmode/107230
Charles Berry 8 years ago
parent
commit
ea94c14d92
1 changed files with 4 additions and 2 deletions
  1. 4 2
      lisp/ob-exp.el

+ 4 - 2
lisp/ob-exp.el

@@ -41,8 +41,10 @@
 (defcustom org-export-babel-evaluate t
 (defcustom org-export-babel-evaluate t
   "Switch controlling code evaluation during export.
   "Switch controlling code evaluation during export.
 When set to nil no code will be evaluated as part of the export
 When set to nil no code will be evaluated as part of the export
-process.  When set to `inline-only', only inline code blocks will
-be executed."
+process and no header argumentss will be obeyed.  When set to
+`inline-only', only inline code blocks will be executed.  Users
+who wish to avoid evaluating code on export should use the header
+argument `:eval never-export'."
   :group 'org-babel
   :group 'org-babel
   :version "24.1"
   :version "24.1"
   :type '(choice (const :tag "Never" nil)
   :type '(choice (const :tag "Never" nil)