diff options
author | Bastien Guerry <bzg@altern.org> | 2011-08-17 11:05:23 +0200 |
---|---|---|
committer | Bastien Guerry <bzg@altern.org> | 2011-08-17 11:05:23 +0200 |
commit | 436290bfabde71dfcd4e3a9a6d9402c0ea343912 (patch) | |
tree | 8713040d1b0d183cd380a4297b7f36cc9e6aa1e7 | |
parent | d13476b9180adc02d6b0a29b5134d858102813c2 (diff) | |
download | org-mode-436290bfabde71dfcd4e3a9a6d9402c0ea343912.tar.gz |
org.el (org-outline-regexp, org-outline-regexp-bol): Add a docstring.
* org.el (org-outline-regexp, org-outline-regexp-bol): Add a
docstring.
-rw-r--r-- | lisp/org.el | 17 |
1 files changed, 13 insertions, 4 deletions
diff --git a/lisp/org.el b/lisp/org.el index 9b5f146..1c11303 100644 --- a/lisp/org.el +++ b/lisp/org.el @@ -4715,10 +4715,19 @@ This variable is set by `org-before-change-function'. (defvar org-inhibit-blocking nil) ; Dynamically-scoped param. (defvar org-table-buffer-is-an nil) -;; org-outline-regexp ought to be a defconst but is let-binding -;; in some places -- e.g. see the macro org-with-limited-levels -(defvar org-outline-regexp "\\*+ ") -(defconst org-outline-regexp-bol "^\\*+ ") +;; `org-outline-regexp' ought to be a defconst but is let-binding in +;; some places -- e.g. see the macro org-with-limited-levels. +;; +;; In Org buffers, the value of `outline-regexp' is that of +;; `org-outline-regexp'. The only function still directly relying on +;; `outline-regexp' is `org-overview' so that `org-cycle' can do its +;; job when `orgstruct-mode' is active. +(defvar org-outline-regexp "\\*+ " + "Regexp to match Org headlines.") +(defconst org-outline-regexp-bol "^\\*+ " + "Regexp to match Org headlines. +This is similar to `org-outline-regexp' but additionally makes +sure that we are at the beginning of the line.") ;;;###autoload (define-derived-mode org-mode outline-mode "Org" |