[Orgmode] [PATCH] Clean up the description of org-archive-location

[Bernt Hansen]

This removes the ambiguous description that might lead org users
to try to set this variable without a '::' separator.  Without
the separated C-c C-x C-S fails with

        Invalid 'org-archive-location'
---
Here's my attempt at cleaning up the documentation of this variable.

This patch is available at git://git.norang.ca/org-mode in the branch
'fix-org-archive-location-docs'

-Bernt

 lisp/org.el |   24 +++++++++++++-----------
 1 files changed, 13 insertions(+), 11 deletions(-)

diff --git a/lisp/org.el b/lisp/org.el
index b660f96..a27b4f1 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -2635,17 +2635,19 @@ If yes, offer to stop it and to save the buffer with 
the changes."
 (defcustom org-archive-location "%s_archive::"
   "The location where subtrees should be archived.
 
-Otherwise, the value of this variable is a string, consisting of two
-parts, separated by a double-colon.
-
-The first part is a file name - when omitted, archiving happens in the same
-file.  %s will be replaced by the current file name (without directory part).
-Archiving to a different file is useful to keep archived entries from
-contributing to the Org-mode Agenda.
-
-The part after the double colon is a headline.  The archived entries will be
-filed under that headline.  When omitted, the subtrees are simply filed away
-at the end of the file, as top-level entries.
+The value of this variable is a string, consisting of two parts,
+separated by a double-colon.  The first part is a filename and
+the second part is a headline.
+
+When the filename is omitted, archiving happens in the same file.
+%s in the filename will be replaced by the current file
+name (without the directory part).  Archiving to a different file
+is useful to keep archived entries from contributing to the
+Org-mode Agenda.
+
+The archived entries will be filed as subtrees of the specified
+headline.  When the headline is omitted, the subtrees are simply
+filed away at the end of the file, as top-level entries.
 
 Here are a few examples:
 \"%s_archive::\"
-- 
1.6.0.4.608.ga9645