From mboxrd@z Thu Jan 1 00:00:00 1970 From: Carsten Dominik Subject: Re: [PATCH] Docstring fixes Date: Sun, 18 Jul 2010 22:30:46 +0200 Message-ID: References: Mime-Version: 1.0 (Apple Message framework v936) Content-Type: text/plain; charset=US-ASCII; format=flowed; delsp=yes Content-Transfer-Encoding: 7bit Return-path: Received: from [140.186.70.92] (port=44909 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1OaaVv-0007xg-Ld for emacs-orgmode@gnu.org; Sun, 18 Jul 2010 16:31:08 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.69) (envelope-from ) id 1OaaVt-0001Qt-Jh for emacs-orgmode@gnu.org; Sun, 18 Jul 2010 16:31:07 -0400 Received: from mail-ey0-f169.google.com ([209.85.215.169]:50737) by eggs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OaaVt-0001Qo-AP for emacs-orgmode@gnu.org; Sun, 18 Jul 2010 16:31:05 -0400 Received: by eydd26 with SMTP id d26so974759eyd.0 for ; Sun, 18 Jul 2010 13:31:04 -0700 (PDT) In-Reply-To: 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: Phil Rooke Cc: emacs-orgmode@gnu.org Hi Phil, I cannot get this patch to apply cleanly. Could you update it, please? Thanks! - Carsten On Jul 18, 2010, at 6:28 PM, Phil Rooke wrote: > > This is the ninth patch in a series that makes some straightforward > corrections to a number of docstrings. Each change is normally to: > > - correct a typo, or > - fix up hyperlinks to function or variable names, or > - ensure slightly better conformance with the documentation guidelines > and tips given in the Elisp manual > > --- > This is a partial patch, mainly focused on fixing some references to > C-u. Given the pending release deadline I thought I may as well send > this now, hopefully it is useful in its own right. > > > diff --git a/lisp/org.el b/lisp/org.el > index acd7031..f8c2026 100644 > --- a/lisp/org.el > +++ b/lisp/org.el > @@ -818,7 +818,8 @@ This can also be set in on a per-file basis with > (defcustom org-cycle-global-at-bob nil > "Cycle globally if cursor is at beginning of buffer and not at a > headline. > This makes it possible to do global cycling without having to use S- > TAB or > -C-u TAB. For this special case to work, the first line of the buffer > +\\[universal-argument] TAB. For this special case to work, the > first line \ > +of the buffer > must not be a headline - it may be empty or some other text. When > used in > this way, `org-cycle-hook' is disables temporarily, to make sure the > cursor stays at the beginning of the buffer. > @@ -1640,7 +1641,6 @@ file identifier are > that does not use any of the group matches, this > case is > handled identically to the second one (i.e. match > against > file name only). > - > In a custom lisp form, you can access the group > matches with > (match-string n link). > > @@ -1660,7 +1660,7 @@ file identifier are > `system' The system command to open files, like `open' on > Windows > and Mac OS X, and mailcap under GNU/Linux. This is > the command > that will be selected if you call `C-c C-o' with a > double > - `C-u C-u' prefix. > + \\[universal-argument] \\[universal-argument] prefix. > > Possible values for the command are: > `emacs' The file will be visited by the current Emacs process. > @@ -5925,7 +5925,7 @@ in special contexts. > ;;;###autoload > (defun org-global-cycle (&optional arg) > "Cycle the global visibility. For details see `org-cycle'. > -With C-u prefix arg, switch to startup visibility. > +With \\[universal-argument] prefix arg, switch to startup visibility. > With a numeric prefix, show all headlines up to that level." > (interactive "P") > (let ((org-cycle-include-plain-lists > @@ -6259,7 +6259,7 @@ point nowhere." > (make-variable-buffer-local 'org-hide-block-overlays) > > (defun org-block-map (function &optional start end) > - "Call function at the head of all source blocks in the current > buffer. > + "Call FUNCTION at the head of all source blocks in the current > buffer. > Optional arguments START and END can be used to limit the range." > (let ((start (or start (point-min))) > (end (or end (point-max)))) > @@ -6548,10 +6548,12 @@ With numerical prefix ARG, go up to this > level and then take that tree. > If ARG is negative, go up that many levels. > If `org-indirect-buffer-display' is not `new-frame', the command > removes the > indirect buffer previously made with this command, to avoid > proliferation of > -indirect buffers. However, when you call the command with a `C-u' > prefix, or > +indirect buffers. However, when you call the command with a \ > +\\[universal-argument] prefix, or > when `org-indirect-buffer-display' is `new-frame', the last buffer > is kept so that you can work with several indirect buffers at the > same time. > -If `org-indirect-buffer-display' is `dedicated-frame', the C-u > prefix also > +If `org-indirect-buffer-display' is `dedicated-frame', the \ > +\\[universal-argument] prefix also > requests that a new frame be made for the new buffer, so that the > dedicated > frame is not changed." > (interactive "P") > @@ -9554,7 +9556,8 @@ entry for this file type, and if yes, the > corresponding command is launched. > If no application is found, Emacs simply visits the file. > > With optional prefix argument IN-EMACS, Emacs will visit the file. > -With a double C-c C-u prefix arg, Org tries to avoid opening in Emacs > +With a double \\[universal-argument] \\[universal-argument] \ > +prefix arg, Org tries to avoid opening in Emacs > and to use an external application to visit the file. > > Optional LINE specifies a line to go to, optional SEARCH a string > @@ -10039,7 +10042,8 @@ below it are allowed. > > With prefix arg GOTO, the command will only visit the target location, > not actually move anything. > -With a double prefix `C-u C-u', go to the location where the last > refiling > +With a double prefix arg \\[universal-argument] \\[universal- > argument], \ > +go to the location where the last refiling > operation has put the subtree. > With a prefix argument of `2', refile to the running clock. > > @@ -12002,7 +12006,8 @@ not t for the search context. > With optional argument SIBLINGS, on each level of the hierarchy all > siblings are shown. This repairs the tree structure to what it would > look like when opened with hierarchical calls to `org-cycle'. > -With double optional argument `C-u C-u', go to the parent and show > the > +With double optional argument \\[universal-argument] \\[universal- > argument], \ > +go to the parent and show the > entire tree." > (interactive "P") > (run-hooks 'org-reveal-start-hook) > @@ -15765,7 +15770,8 @@ If the cursor is in a LaTeX fragment, create > the image and overlay > it over the source code. If there is no fragment at point, display > all fragments in the current text, from one headline to the next. > With > prefix SUBTREE, display all fragments in the current subtree. With a > -double prefix `C-u C-u', or when the cursor is before the first > headline, > +double prefix arg \\[universal-argument] \\[universal-argument], or > when \ > +the cursor is before the first headline, > display all fragments in the buffer. > The images can be removed again with \\[org-ctrl-c-ctrl-c]." > (interactive "P") > @@ -18835,7 +18841,8 @@ org-yank-adjusted-subtrees > *visible* surrounding headings. > > Any prefix to this command will cause `yank' to be called directly > with > -no special treatment. In particular, a simple `C-u' prefix will just > +no special treatment. In particular, a simple \\[universal- > argument] prefix \ > +will just > plainly yank the text as it is. > > \[1] The test checks if the first non-white line is a heading > > _______________________________________________ > Emacs-orgmode mailing list > Please use `Reply All' to send replies to the list. > Emacs-orgmode@gnu.org > http://lists.gnu.org/mailman/listinfo/emacs-orgmode - Carsten