From mboxrd@z Thu Jan 1 00:00:00 1970 From: Carsten Dominik Subject: Re: [PATCH] Clean up the description of org-archive-location Date: Thu, 20 Nov 2008 08:26:32 +0100 Message-ID: <8A25DB21-DB8F-43A9-8659-682103E9F97B@uva.nl> References: <878wrf1x7v.fsf@fastmail.fm> <8984.1227114553@alphaville.usa.hp.com> <877i6zzl41.fsf_-_@gollum.intra.norang.ca> Mime-Version: 1.0 (Apple Message framework v929.2) Content-Type: text/plain; charset=US-ASCII; format=flowed; delsp=yes Content-Transfer-Encoding: 7bit Return-path: Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1L33w1-0001xk-4g for emacs-orgmode@gnu.org; Thu, 20 Nov 2008 02:26:41 -0500 Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1L33w0-0001xC-FH for emacs-orgmode@gnu.org; Thu, 20 Nov 2008 02:26:40 -0500 Received: from [199.232.76.173] (port=45903 helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1L33w0-0001x0-98 for emacs-orgmode@gnu.org; Thu, 20 Nov 2008 02:26:40 -0500 Received: from ug-out-1314.google.com ([66.249.92.172]:27852) by monty-python.gnu.org with esmtp (Exim 4.60) (envelope-from ) id 1L33vz-0000Zr-Hm for emacs-orgmode@gnu.org; Thu, 20 Nov 2008 02:26:39 -0500 Received: by ug-out-1314.google.com with SMTP id 36so219586uga.17 for ; Wed, 19 Nov 2008 23:26:38 -0800 (PST) In-Reply-To: <877i6zzl41.fsf_-_@gollum.intra.norang.ca> 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: Bernt Hansen Cc: emacs-orgmode@gnu.org Another delicious cherry for me to pick, thanks Bernt and Nick. Bernt, I think I am ripe for a little lecture about remote repositories and tracking them, so that I do not need to type the location of your repo each time... :-) - Carsten On Nov 19, 2008, at 6:22 PM, Bernt Hansen wrote: > > 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 > > > > _______________________________________________ > Emacs-orgmode mailing list > Remember: use `Reply All' to send replies to the list. > Emacs-orgmode@gnu.org > http://lists.gnu.org/mailman/listinfo/emacs-orgmode