From: Bernt Hansen <bernt@norang.ca>
To: nicholas.dokos@hp.com
Cc: emacs-orgmode@gnu.org
Subject: [PATCH] Clean up the description of org-archive-location
Date: Wed, 19 Nov 2008 12:22:38 -0500 [thread overview]
Message-ID: <877i6zzl41.fsf_-_@gollum.intra.norang.ca> (raw)
In-Reply-To: <8984.1227114553@alphaville.usa.hp.com> (Nick Dokos's message of "Wed\, 19 Nov 2008 12\:09\:13 -0500")
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
next prev parent reply other threads:[~2008-11-19 17:22 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2008-11-19 16:45 org-archive-location Matthew Lundin
2008-11-19 17:09 ` org-archive-location Nick Dokos
2008-11-19 17:22 ` Bernt Hansen [this message]
2008-11-20 7:26 ` [PATCH] Clean up the description of org-archive-location Carsten Dominik
2008-12-02 12:48 ` Christian Egli
2008-12-02 13:24 ` Bernt Hansen
2008-11-19 17:09 ` org-archive-location Bernt Hansen
2008-11-19 17:30 ` org-archive-location Matthew Lundin
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=877i6zzl41.fsf_-_@gollum.intra.norang.ca \
--to=bernt@norang.ca \
--cc=emacs-orgmode@gnu.org \
--cc=nicholas.dokos@hp.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).