[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH] fix various manpage typos
From: |
Nix |
Subject: |
[PATCH] fix various manpage typos |
Date: |
Sun, 15 May 2011 16:58:29 +0100 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/24.0.50 (gnu/linux) |
I just read through the Emacs and elisp manuals as part of migration
from XEmacs. I found some typos and outright errors in the process: here
are fixes for these. Ignoring the typo fixes, I fixed the following:
- nobody in the computing community has called `goto' `go to' for more
years than I've been alive.
- `x-select-enable-clipboard' is t virtually everywhere these days,
not nil.
- It is not `good' to use control sequences for control and meta key
sequences: it needlessly limits portability between Emacsen. If I'd
followed this advice, my migration back from XEmacs would have been
horrible, and I don't think anyone here wants that. It is
*permissible*. It works, but is not necessarily a good idea. (The
original also read very strangely to me: you just don't use `good' in
this situation in idiomatic English. Or at least this native speaker
never would.)
- Drop the note about Common Lisp having `union' and `intersection'
but elisp not having them. They are in `cl-seq'. I don't fully
understand the GNU Emacs dislike of loading cl.el at runtime, but
surely this does not extend to telling users that functions defined
in it do not exist!
- The libxml interfaces changed names a while back, but the
documentation was not updated to match.
Index: emacs/doc/lispref/control.texi
===================================================================
--- emacs.orig/doc/lispref/control.texi 2011-05-15 16:41:26.022116326 +0100
+++ emacs/doc/lispref/control.texi 2011-05-15 16:41:36.301388580 +0100
@@ -623,7 +623,7 @@
@subsection Examples of @code{catch} and @code{throw}
One way to use @code{catch} and @code{throw} is to exit from a doubly
-nested loop. (In most languages, this would be done with a ``go to.'')
+nested loop. (In most languages, this would be done with a ``goto.'')
Here we compute @code{(foo @var{i} @var{j})} for @var{i} and @var{j}
varying from 0 to 9:
Index: emacs/doc/lispref/customize.texi
===================================================================
--- emacs.orig/doc/lispref/customize.texi 2011-05-15 16:41:26.022116326
+0100
+++ emacs/doc/lispref/customize.texi 2011-05-15 16:41:36.301388580 +0100
@@ -174,7 +174,7 @@
The value of @var{package} needs to be unique and it needs to match
the @var{package} value appearing in the @code{:package-version}
-keyword. Since the user might see the value in a error message, a good
+keyword. Since the user might see the value in an error message, a good
choice is the official name of the package, such as MH-E or Gnus.
@end defvar
Index: emacs/doc/lispref/display.texi
===================================================================
--- emacs.orig/doc/lispref/display.texi 2011-05-15 16:41:26.022116326 +0100
+++ emacs/doc/lispref/display.texi 2011-05-15 16:41:36.311387872 +0100
@@ -5201,7 +5201,7 @@
Typically, you define an ewoc with @code{ewoc-create}, and then pass
the resulting ewoc structure to other functions in the Ewoc package to
build nodes within it, and display it in the buffer. Once it is
-displayed in the buffer, other functions determine the correspondance
+displayed in the buffer, other functions determine the correspondence
between buffer positions and nodes, move point from one node's textual
representation to another, and so forth. @xref{Abstract Display
Functions}.
Index: emacs/doc/lispref/frames.texi
===================================================================
--- emacs.orig/doc/lispref/frames.texi 2011-05-15 16:41:26.022116326 +0100
+++ emacs/doc/lispref/frames.texi 2011-05-15 16:41:36.311387872 +0100
@@ -1368,7 +1368,7 @@
However, you can also create a frame with no minibuffer. Such a frame
must use the minibuffer window of some other frame. When you create the
-frame, you can specify explicitly the minibuffer window to use (in some
+frame, you can explicitly specify the minibuffer window to use (in some
other frame). If you don't, then the minibuffer is found in the frame
which is the value of the variable @code{default-minibuffer-frame}. Its
value should be a frame that does have a minibuffer.
@@ -2018,8 +2018,8 @@
If this is address@hidden, the Emacs yank functions consult the
clipboard before the primary selection, and the kill functions store in
the clipboard as well as the primary selection. Otherwise they do not
-access the clipboard at all. The default is @code{nil} on most systems,
-but @code{t} on MS-Windows.
+access the clipboard at all. The default is @code{t} on systems with
+clipboards.
@end defopt
@node Drag and Drop
Index: emacs/doc/lispref/keymaps.texi
===================================================================
--- emacs.orig/doc/lispref/keymaps.texi 2011-05-15 16:41:26.032115618 +0100
+++ emacs/doc/lispref/keymaps.texi 2011-05-15 16:41:36.311387872 +0100
@@ -685,8 +685,8 @@
bindings, as in @code{lookup-key} (@pxref{Functions for Key Lookup}).
When commands are remapped (@pxref{Remapping Commands}),
address@hidden normally processes command remappings so as to
-returns the remapped command that will actually be executed. However,
address@hidden normally processes command remappings so as to
+return the remapped command that will actually be executed. However,
if @var{no-remap} is address@hidden, @code{key-binding} ignores
remappings and returns the binding directly specified for @var{key}.
@@ -1239,7 +1239,7 @@
The @code{global-set-key} and @code{local-set-key} functions are
convenient interfaces for these operations (@pxref{Key Binding
Commands}). You can also use @code{define-key}, a more general
-function; then you must specify explicitly the map to change.
+function; then you must explicitly specify the map to change.
When choosing the key sequences for Lisp programs to rebind, please
follow the Emacs conventions for use of various keys (@pxref{Key
@@ -1247,16 +1247,17 @@
@cindex meta character key constants
@cindex control character key constants
- In writing the key sequence to rebind, it is good to use the special
-escape sequences for control and meta characters (@pxref{String Type}).
-The syntax @samp{\C-} means that the following character is a control
-character and @samp{\M-} means that the following character is a meta
-character. Thus, the string @code{"\M-x"} is read as containing a
-single @kbd{M-x}, @code{"\C-f"} is read as containing a single
address@hidden, and @code{"\M-\C-x"} and @code{"\C-\M-x"} are both read as
-containing a single @kbd{C-M-x}. You can also use this escape syntax in
-vectors, as well as others that aren't allowed in strings; one example
-is @samp{[?\C-\H-x home]}. @xref{Character Type}.
+ In writing the key sequence to rebind, it is permissible to use the
+special escape sequences for control and meta characters
+(@pxref{String Type}). The syntax @samp{\C-} means that the following
+character is a control character and @samp{\M-} means that the
+following character is a meta character. Thus, the string
address@hidden"\M-x"} is read as containing a single @kbd{M-x}, @code{"\C-f"}
+is read as containing a single @kbd{C-f}, and @code{"\M-\C-x"} and
address@hidden"\C-\M-x"} are both read as containing a single @kbd{C-M-x}.
+You can also use this escape syntax in vectors, as well as others that
+aren't allowed in strings; one example is @samp{[?\C-\H-x home]}.
address@hidden Type}.
The key definition and lookup functions accept an alternate syntax for
event types in a key sequence that is a vector: you can use a list
Index: emacs/doc/lispref/lists.texi
===================================================================
--- emacs.orig/doc/lispref/lists.texi 2011-05-15 16:41:26.032115618 +0100
+++ emacs/doc/lispref/lists.texi 2011-05-15 16:41:36.311387872 +0100
@@ -1263,14 +1263,6 @@
functions for sets include @code{memq} and @code{delq}, and their
@code{equal} versions, @code{member} and @code{delete}.
address@hidden CL note---lack @code{union}, @code{intersection}
address@hidden
address@hidden Lisp note:} Common Lisp has functions @code{union} (which
-avoids duplicate elements) and @code{intersection} for set operations,
-but GNU Emacs Lisp does not have them. You can write them in Lisp if
-you wish.
address@hidden quotation
-
@defun memq object list
@cindex membership in a list
This function tests to see whether @var{object} is a member of
@@ -1355,10 +1347,10 @@
(delq '(4) sample-list)
@result{} (a c (4))
@end group
address@hidden example
If you want to delete elements that are @code{equal} to a given value,
use @code{delete} (see below).
address@hidden example
@defun remq object list
This function returns a copy of @var{list}, with all elements removed
Index: emacs/doc/lispref/markers.texi
===================================================================
--- emacs.orig/doc/lispref/markers.texi 2011-05-15 16:41:26.032115618 +0100
+++ emacs/doc/lispref/markers.texi 2011-05-15 16:41:36.311387872 +0100
@@ -453,7 +453,7 @@
@defun mark-marker
This function returns the marker that represents the current buffer's
-mark. It is not a copy, it is the marker used internally. Therefore,
+mark. It is not a copy; it is the marker used internally. Therefore,
changing this marker's position will directly affect the buffer's
mark. Don't do that unless that is the effect you want.
Index: emacs/doc/lispref/modes.texi
===================================================================
--- emacs.orig/doc/lispref/modes.texi 2011-05-15 16:41:26.032115618 +0100
+++ emacs/doc/lispref/modes.texi 2011-05-15 16:41:36.311387872 +0100
@@ -3256,7 +3256,7 @@
@end defvar
@node Auto-Indentation
address@hidden Auto-indention of code
address@hidden Auto-indentation of code
For programming languages, an important feature of a major mode is to
provide automatic indentation. This is controlled in Emacs by
Index: emacs/doc/lispref/nonascii.texi
===================================================================
--- emacs.orig/doc/lispref/nonascii.texi 2011-05-15 16:41:26.032115618
+0100
+++ emacs/doc/lispref/nonascii.texi 2011-05-15 16:41:36.311387872 +0100
@@ -201,7 +201,7 @@
@defun byte-to-string byte
@cindex byte to string
This function returns a unibyte string containing a single byte of
-character data, @var{character}. It signals a error if
+character data, @var{character}. It signals an error if
@var{character} is not an integer between 0 and 255.
@end defun
Index: emacs/doc/lispref/syntax.texi
===================================================================
--- emacs.orig/doc/lispref/syntax.texi 2011-05-15 16:41:26.032115618 +0100
+++ emacs/doc/lispref/syntax.texi 2011-05-15 16:41:36.311387872 +0100
@@ -374,7 +374,7 @@
@item @samp{*/}
This is a comment-end sequence for ``b'' style because the first
-character, @samp{*}, does have the @samp{b} flag.
+character, @samp{*}, has the @samp{b} flag.
@item newline
This is a comment-end sequence for ``a'' style, because the newline
Index: emacs/doc/lispref/text.texi
===================================================================
--- emacs.orig/doc/lispref/text.texi 2011-05-15 16:41:26.032115618 +0100
+++ emacs/doc/lispref/text.texi 2011-05-15 16:41:36.311387872 +0100
@@ -4099,17 +4099,16 @@
@node Parsing HTML
@section Parsing HTML
@cindex parsing html
address@hidden parsing xml
-
-Emacs provides an interface to the @code{libxml2} library via two
-functions: @code{html-parse-buffer} and @code{xml-parse-buffer}. The
-HTML function will parse ``real world'' HTML and try to return a
-sensible parse tree, while the XML function is somewhat stricter about
-syntax.
-They both take a two optional parameter. The first is a buffer, and
-the second is a base URL to be used to expand relative URLs in the
-document, if any.
address@hidden libxml-parse-html-region start end &optional base-url
+This function provides HTML parsing via the @code{libxml2} library It
+parses ``real world'' HTML and tries to return a sensible parse tree
+regardless.
+
+In addition to @var{start} and @var{end} (specifying the start and end
+of the region to act on), it takes an optional parameter,
address@hidden, which is used to expand relative URLs in the document,
+if any.
Here's an example demonstrating the structure of the parsed data you
get out. Given this HTML document:
@@ -4138,12 +4137,21 @@
Attributes are coded the same way as child nodes, but with @samp{:} as
the first character.
address@hidden defun
+
address@hidden parsing xml
address@hidden libxml-parse-xml-region start end &optional base-url
+
+This is much the same as @code{libxml-parse-html-region} above, but
+operates on XML instead of HTML, and is correspondingly stricter about
+syntax.
address@hidden defun
@node Atomic Changes
@section Atomic Change Groups
@cindex atomic changes
- In data base terminology, an @dfn{atomic} change is an indivisible
+ In database terminology, an @dfn{atomic} change is an indivisible
change---it can succeed entirely or it can fail entirely, but it
cannot partly succeed. A Lisp program can make a series of changes to
one or several buffers as an @dfn{atomic change group}, meaning that
Index: emacs/doc/lispref/windows.texi
===================================================================
--- emacs.orig/doc/lispref/windows.texi 2011-05-15 16:41:26.032115618 +0100
+++ emacs/doc/lispref/windows.texi 2011-05-15 16:41:36.311387872 +0100
@@ -826,8 +826,8 @@
unless @var{norecord} is address@hidden
@end deffn
address@hidden Command pop-to-buffer buffer-or-name &optional other-window
norecord
-This command makes @var{buffer-or-name} the current buffer and switches
address@hidden pop-to-buffer buffer-or-name &optional other-window norecord
+This function makes @var{buffer-or-name} the current buffer and switches
to it in some window, preferably not the window previously selected.
The ``popped-to'' window becomes the selected window. Its frame is
given the X server's focus, if possible; see @ref{Input Focus}. The
@@ -866,7 +866,7 @@
This function updates the buffer list just like @code{switch-to-buffer}
unless @var{norecord} is address@hidden
address@hidden deffn
address@hidden defun
@deffn Command replace-buffer-in-windows &optional buffer-or-name
This function replaces @var{buffer-or-name} in all windows displaying
--
NULL && (void)
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [PATCH] fix various manpage typos,
Nix <=