From mboxrd@z Thu Jan 1 00:00:00 1970 From: Bernt Hansen Subject: [PATCH] Clean up the description of org-archive-location Date: Wed, 19 Nov 2008 12:22:38 -0500 Message-ID: <877i6zzl41.fsf_-_@gollum.intra.norang.ca> References: <878wrf1x7v.fsf@fastmail.fm> <8984.1227114553@alphaville.usa.hp.com> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Return-path: Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1L2qlI-00067z-T9 for emacs-orgmode@gnu.org; Wed, 19 Nov 2008 12:22:44 -0500 Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1L2qlI-00067i-Ee for emacs-orgmode@gnu.org; Wed, 19 Nov 2008 12:22:44 -0500 Received: from [199.232.76.173] (port=38897 helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1L2qlI-00067d-5q for emacs-orgmode@gnu.org; Wed, 19 Nov 2008 12:22:44 -0500 Received: from mho-02-bos.mailhop.org ([63.208.196.179]:55474) by monty-python.gnu.org with esmtps (TLS-1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1L2qlH-0001RH-SZ for emacs-orgmode@gnu.org; Wed, 19 Nov 2008 12:22:44 -0500 In-Reply-To: <8984.1227114553@alphaville.usa.hp.com> (Nick Dokos's message of "Wed\, 19 Nov 2008 12\:09\:13 -0500") List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org To: nicholas.dokos@hp.com Cc: emacs-orgmode@gnu.org 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