summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJambunathan K <kjambunathan@gmail.com>2011-07-20 15:02:53 +0530
committerBastien Guerry <bzg@altern.org>2011-07-21 11:18:16 +0200
commitcce01dd380ae0b8d54f623bf6f96e0e1872e8c1f (patch)
tree607662861fcf3bf7705d956be5956d55d5780fdd
parentd8bd43ed5f5849315787aa1fb5ce2f9032802bf3 (diff)
downloadorg-mode-cce01dd380ae0b8d54f623bf6f96e0e1872e8c1f.tar.gz
org-lparse: Update docstring of org-lparse-debug
* contrib/lisp/org-lparse.el (org-lparse-debug): Improve docstring.
-rwxr-xr-xcontrib/lisp/org-lparse.el21
1 files changed, 18 insertions, 3 deletions
diff --git a/contrib/lisp/org-lparse.el b/contrib/lisp/org-lparse.el
index 7665591..c96ec84 100755
--- a/contrib/lisp/org-lparse.el
+++ b/contrib/lisp/org-lparse.el
@@ -1595,9 +1595,24 @@ the alist of previous items."
(defvar org-lparse-output-buffer)
(defcustom org-lparse-debug nil
- "Turn on/off debugging for `org-lparse'."
- :type 'boolean
- :group 'org-lparse)
+ "Enable or Disable logging of `org-lparse' callbacks.
+The parameters passed to the backend-registered ENTITY-CONTROL
+and ENTITY-FORMAT callbacks are logged as comment strings in the
+exported buffer. (org-lparse-format 'COMMENT fmt args) is used
+for logging. Customize this variable only if you are an expert
+user. Valid values of this variable are:
+nil : Disable logging
+control : Log all invocations of `org-lparse-begin' and
+ `org-lparse-end' callbacks.
+format : Log invocations of `org-lparse-format' callbacks.
+t : Log all invocations of `org-lparse-begin', `org-lparse-end'
+ and `org-lparse-format' callbacks,"
+ :group 'org-lparse
+ :type '(choice
+ (const :tag "Disable" nil)
+ (const :tag "Format callbacks" format)
+ (const :tag "Control callbacks" control)
+ (const :tag "Format and Control callbacks" t)))
(defun org-lparse-begin (entity &rest args)
"Begin ENTITY in current buffer. ARGS is entity specific.