changeset 2757:7844ab77b582

[xemacs-hg @ 2005-05-05 17:10:19 by aidan] Some spelling and grammar fixes.
author aidan
date Thu, 05 May 2005 17:10:54 +0000
parents f441e940eed8
children bf875d8664db
files etc/ChangeLog etc/NEWS lisp/ChangeLog lisp/map-ynp.el lisp/mule/mule-ccl.el man/ChangeLog man/xemacs/building.texi man/xemacs/entering.texi man/xemacs/menus.texi man/xemacs/text.texi src/ChangeLog src/select.c src/sound.c
diffstat 13 files changed, 88 insertions(+), 50 deletions(-) [+]
line wrap: on
line diff
--- a/etc/ChangeLog	Thu May 05 16:55:41 2005 +0000
+++ b/etc/ChangeLog	Thu May 05 17:10:54 2005 +0000
@@ -1,3 +1,7 @@
+2005-05-05  Aidan Kehoe  <kehoea@parhasard.net>
+
+	* NEWS: reseource -> resources (spelling fix.)
+
 2005-03-24  Aidan Kehoe  <kehoea@parhasard.net>
 
 	* NEWS: Mention the move to XEmacs as the application class. 
--- a/etc/NEWS	Thu May 05 16:55:41 2005 +0000
+++ b/etc/NEWS	Thu May 05 17:10:54 2005 +0000
@@ -47,14 +47,14 @@
 ** "XEmacs" used as X11 application class
 
 Previously, XEmacs checked the X11 resource database for resources starting
-with XEmacs, and used "XEmacs" as its application class if any existed,
-otherwise using "Emacs" for backward compatibility.  Because of divergence
-between the reseource GNU Emacs and XEmacs use, this has been changed; if
-you don't have the time to migrate your resource DB right now, set
-USE_EMACS_AS_DEFAULT_APPLICATION_CLASS in your environment before starting
-XEmacs, for the old behavior.  This workaround will go away in the course of
-the next major release, though, so you will have to migrate your resources
-at some point. 
+with XEmacs, and used "XEmacs" as its application class if any existed;
+otherwise it used "Emacs", for backward compatibility.  Because of
+divergence between the resources that GNU Emacs and XEmacs use, we've
+changed this.  If you don't have the time to migrate your resource DB right
+now, set USE_EMACS_AS_DEFAULT_APPLICATION_CLASS in your environment before
+starting XEmacs, for the old behavior.  This workaround will go away in the
+course of the next major release, though, so you will have to migrate your
+resources at some point.
 
 
 * Changes in XEmacs 21.4
--- a/lisp/ChangeLog	Thu May 05 16:55:41 2005 +0000
+++ b/lisp/ChangeLog	Thu May 05 17:10:54 2005 +0000
@@ -1,3 +1,12 @@
+2005-05-05  Aidan Kehoe  <kehoea@parhasard.net>
+
+	* mule/mule-ccl.el (define-ccl-program): Spelling and grammar fix
+	in docstring. 
+
+2005-05-05  Aidan Kehoe  <kehoea@parhasard.net>
+
+	* map-ynp.el: Grammar fix in comment. 
+
 2005-05-05  Aidan Kehoe  <kehoea@parhasard.net>
 
 	* startup.el (command-line): Call font-lock-set-defaults to make
--- a/lisp/map-ynp.el	Thu May 05 16:55:41 2005 +0000
+++ b/lisp/map-ynp.el	Thu May 05 17:10:54 2005 +0000
@@ -30,7 +30,7 @@
 
 ;; map-y-or-n-p is a general-purpose question-asking function.
 ;; It asks a series of y/n questions (a la y-or-n-p), and decides to
-;; applies an action to each element of a list based on the answer.
+;; apply an action to each element of a list based on the answer.
 ;; The nice thing is that you also get some other possible answers
 ;; to use, reminiscent of query-replace: ! to answer y to all remaining
 ;; questions; ESC or q to answer n to all remaining questions; . to answer
--- a/lisp/mule/mule-ccl.el	Thu May 05 16:55:41 2005 +0000
+++ b/lisp/mule/mule-ccl.el	Thu May 05 17:10:54 2005 +0000
@@ -1238,7 +1238,7 @@
 
 ;;;###autoload
 (defmacro define-ccl-program (name ccl-program &optional doc)
-  "Set NAME the compiled code of CCL-PROGRAM.
+  "Set NAME to be the compiled CCL code of CCL-PROGRAM.
 
 CCL-PROGRAM has this form:
 	(BUFFER_MAGNIFICATION
@@ -1250,14 +1250,13 @@
 text.  If the value is zero, the CCL program can't execute `read' and
 `write' commands.
 
-CCL_MAIN_CODE and CCL_EOF_CODE are CCL program codes.  CCL_MAIN_CODE
-executed at first.  If there's no more input data when `read' command
-is executed in CCL_MAIN_CODE, CCL_EOF_CODE is executed.  If
-CCL_MAIN_CODE is terminated, CCL_EOF_CODE is not executed.
+CCL_MAIN_CODE and CCL_EOF_CODE are CCL program codes.  CCL_MAIN_CODE is
+executed first.  If there are no more input data when a `read' command is
+executed in CCL_MAIN_CODE, CCL_EOF_CODE is executed.  If CCL_MAIN_CODE is
+terminated, CCL_EOF_CODE is not executed.
 
-Here's the syntax of CCL program code in BNF notation.  The lines
-starting by two semicolons (and optional leading spaces) describe the
-semantics.
+Here's the syntax of CCL program code in BNF notation.  The lines starting
+with two semicolons (and optional leading spaces) describe the semantics.
 
 CCL_MAIN_CODE := CCL_BLOCK
 
@@ -1276,7 +1275,7 @@
 
 EXPRESSION := ARG | (EXPRESSION OPERATOR ARG)
 
-;; Evaluate EXPRESSION.  If the result is nonzeor, execute
+;; Evaluate EXPRESSION.  If the result is nonzero, execute
 ;; CCL_BLOCK_0.  Otherwise, execute CCL_BLOCK_1.
 IF :=	(if EXPRESSION CCL_BLOCK_0 [CCL_BLOCK_1])
 
@@ -1287,11 +1286,11 @@
 ;; Execute STATEMENTs until (break) or (end) is executed.
 LOOP := (loop STATEMENT [STATEMENT ...])
 
-;; Terminate the most inner loop.
+;; Terminate the innermost loop.
 BREAK := (break)
 
 REPEAT :=
-	;; Jump to the head of the most inner loop.
+	;; Jump to the head of the innermost loop.
 	(repeat)
 	;; Same as: ((write [REG | INT-OR-CHAR | string])
 	;;	     (repeat))
@@ -1306,7 +1305,11 @@
 	| (write-read-repeat REG INT-OR-CHAR)
 
 READ := ;; Set REG_0 to a byte read from the input text, set REG_1
-	;; to the next byte read, and so on.
+	;; to the next byte read, and so on. Note that \"byte\" here means
+	;; \"some octet from XEmacs' internal representation\", which may
+	;; not be that useful to you when non-ASCII characters are involved.
+        ;;
+        ;; Yes, this is exactly the opposite of what (write ...) does.
 	(read REG_0 [REG_1 ...])
 	;; Same as: ((read REG)
 	;;	     (if (REG OPERATOR ARG) CCL_BLOCK_0 CCL_BLOCK_1))
@@ -1314,12 +1317,12 @@
 	;; Same as: ((read REG)
 	;;	     (branch REG CCL_BLOCK_0 [CCL_BLOCK_1 ...]))
 	| (read-branch REG CCL_BLOCK_0 [CCL_BLOCK_1 ...])
-	;; Read a character from the input text while parsing
-	;; multibyte representation, set REG_0 to the charset ID of
-	;; the character, set REG_1 to the code point of the
-	;; character.  If the dimension of charset is two, set REG_1
-	;; to ((CODE0 << 8) | CODE1), where CODE0 is the first code
-	;; point and CODE1 is the second code point.
+	;; Read a character from the input text, splitting it into its
+	;; multibyte representation. Set REG_0 to the charset ID of the
+	;; character, and set REG_1 to the code point of the character.  If
+	;; the dimension of charset is two, set REG_1 to ((CODE0 << 8) |
+	;; CODE1), where CODE0 is the first code point and CODE1 is the
+	;; second code point.
 	| (read-multibyte-character REG_0 REG_1)
 
 WRITE :=
@@ -1356,7 +1359,7 @@
 ;; Call CCL program whose name is ccl-program-name.
 CALL := (call ccl-program-name)
 
-TRANSLATE :=
+TRANSLATE := ;; Not implemented under XEmacs.
 	(translate-character REG(table) REG(charset) REG(codepoint))
 	| (translate-character SYMBOL REG(charset) REG(codepoint))
 MAP :=
@@ -1370,17 +1373,17 @@
 ;; Terminate the CCL program.
 END := (end)
 
-;; CCL registers that can contain any integer value.  As r7 is also
-;; used by CCL interpreter, its value is changed unexpectedly.
+;; CCL registers. These can contain any integer value.  As r7 is used by CCL
+;; interpreter itself, its value change unexpectedly.
 REG := r0 | r1 | r2 | r3 | r4 | r5 | r6 | r7
 
 ARG := REG | INT-OR-CHAR
 
 OPERATOR :=
-	;; Normal arithmethic operators (same meaning as C code).
+	;; Normal arithmetical operators (same meaning as C code).
 	+ | - | * | / | %
 
-	;; Bitwize operators (same meaning as C code)
+	;; Bitwise operators (same meaning as C code)
 	| & | `|' | ^
 
 	;; Shifting operators (same meaning as C code)
--- a/man/ChangeLog	Thu May 05 16:55:41 2005 +0000
+++ b/man/ChangeLog	Thu May 05 17:10:54 2005 +0000
@@ -1,3 +1,15 @@
+2005-05-05  Aidan Kehoe  <kehoea@parhasard.net>
+
+	* xemacs/building.texi (Lisp Modes):
+	* xemacs/building.texi (Lisp Interaction):
+	* xemacs/entering.texi (Entering Emacs):
+	* xemacs/menus.texi (File Menu):
+	* xemacs/text.texi (Auto Fill):
+	None of the keymaps I have access to have linefeed keys; they all
+	use Return. As such, for new users, C-j is really the only option
+	for evaluation in Lisp interaction mode, and should be documented
+	as such. 
+	
 2005-04-18  Turnbull Stephen  <stephen@xemacs.org>
 
 	* internals/internals.texi
--- a/man/xemacs/building.texi	Thu May 05 16:55:41 2005 +0000
+++ b/man/xemacs/building.texi	Thu May 05 17:10:54 2005 +0000
@@ -139,7 +139,7 @@
 @xref{Lisp Libraries}.
 @item Lisp Interaction mode
 The mode for an interactive session with Emacs Lisp.  It defines
-@key{LFD} to evaluate the sexp before point and insert its value in the
+@kbd{C-j} to evaluate the sexp before point and insert its value in the
 buffer.  @xref{Lisp Interaction}.
 @item Lisp mode
 The mode for editing source files of programs that run in other dialects
@@ -551,14 +551,14 @@
 the expressions you evaluate and their output goes in the buffer.
 
   The @samp{*scratch*} buffer's major mode is Lisp Interaction mode, which
-is the same as Emacs-Lisp mode except for one command, @key{LFD}.  In
-Emacs-Lisp mode, @key{LFD} is an indentation command.  In Lisp
-Interaction mode, @key{LFD} is bound to @code{eval-print-last-sexp}.  This
+is the same as Emacs-Lisp mode except for one command, @kbd{C-j}.  In
+Emacs-Lisp mode, @kbd{C-j} is an indentation command.  In Lisp
+Interaction mode, @kbd{C-j} is bound to @code{eval-print-last-sexp}.  This
 function reads the Lisp expression before point, evaluates it, and inserts
 the value in printed representation before point.
 
  The way to use the @samp{*scratch*} buffer is to insert Lisp
-expressions at the end, ending each one with @key{LFD} so that it will
+expressions at the end, ending each one with @kbd{C-j} so that it will
 be evaluated.  The result is a complete typescript of the expressions
 you have evaluated and their values.
 
--- a/man/xemacs/entering.texi	Thu May 05 16:55:41 2005 +0000
+++ b/man/xemacs/entering.texi	Thu May 05 17:10:54 2005 +0000
@@ -28,9 +28,12 @@
 a current buffer for editing, it presents a buffer, by default, a buffer
 named @samp{*scratch*}.  The buffer is in Lisp Interaction mode; you can
 use it to type Lisp expressions and evaluate them, or you can ignore
-that capability and simply doodle.  (You can specify a different major
-mode for this buffer by setting the variable @code{initial-major-mode}
-in your init file.  @xref{Init File}.)
+that capability and simply doodle. (Which is where the name comes from;
+a ``scratch pad'' is a set of paper for doodling on, something not
+necessarily clear to all the English-speakers who read this.)
+
+You can specify a different major mode for this buffer by setting the
+variable @code{initial-major-mode} in your init file.  @xref{Init File}.
 
   It is possible to specify files to be visited, Lisp files to be
 loaded, and functions to be called, by giving Emacs arguments in the
--- a/man/xemacs/menus.texi	Thu May 05 16:55:41 2005 +0000
+++ b/man/xemacs/menus.texi	Thu May 05 17:10:54 2005 +0000
@@ -175,8 +175,8 @@
 
 @item New Frame
 Creates a new Emacs frame displaying the @code{*scratch*} buffer.  This
-is like the @b{Open File, New Frame...} menu item, except that it does
-not prompt for or load a file.@refill
+is like the @b{Open in New Frame...} menu item, except that it does
+not prompt for nor load a file.@refill
 
 @item Delete Frame 
 Allows you to close all but one of the frames created by @b{New Frame}.
--- a/man/xemacs/text.texi	Thu May 05 16:55:41 2005 +0000
+++ b/man/xemacs/text.texi	Thu May 05 17:10:54 2005 +0000
@@ -924,12 +924,13 @@
 is a minor mode; you can turn it on or off for each buffer individually.
 @xref{Minor Modes}.
 
-  In Auto Fill mode, lines are broken automatically at spaces when they get
-longer than desired.  Line breaking and rearrangement takes place
-only when you type @key{SPC} or @key{RET}.  To insert a space
-or newline without permitting line-breaking, type @kbd{C-q @key{SPC}} or
-@kbd{C-q @key{LFD}} (recall that a newline is really a linefeed).
-@kbd{C-o} inserts a newline without line breaking.
+  In Auto Fill mode, lines are broken automatically at spaces when they
+get longer than desired.  Line breaking and rearrangement takes place
+only when you type @key{SPC} or @key{RET}.  To insert a space or newline
+without permitting line-breaking, type @kbd{C-q @key{SPC}} or @kbd{C-q
+C-j}. This last inserts the LINE FEED character, which is how a newline
+is represented in XEmacs' internal encoding.  @kbd{C-o} inserts a
+newline without line breaking.
 
   Auto Fill mode works well with Lisp mode: when it makes a new line in
 Lisp mode, it indents that line with @key{TAB}.  If a line ending in a
--- a/src/ChangeLog	Thu May 05 16:55:41 2005 +0000
+++ b/src/ChangeLog	Thu May 05 17:10:54 2005 +0000
@@ -1,3 +1,9 @@
+2005-05-05  Aidan Kehoe  <kehoea@parhasard.net>
+
+	* select.c:
+	* sound.c: 
+	Spelling fixes to docstrings. 
+
 2005-04-27  Stephen J. Turnbull  <stephen@xemacs.org>
 
 	Allow suppression of WM decorations.
--- a/src/select.c	Thu May 05 16:55:41 2005 +0000
+++ b/src/select.c	Thu May 05 17:10:54 2005 +0000
@@ -514,7 +514,7 @@
 
 /* Get the timestamp of the given selection */
 DEFUN ("get-xemacs-selection-timestamp", Fget_selection_timestamp, 1, 1, 0, /*
-Return timestamp for SELECTION, if belongs to XEmacs and exists.
+Return timestamp for SELECTION, if it belongs to XEmacs and exists.
 
 The timestamp is a cons of two integers, the first being the higher-order
 sixteen bits of the device-specific thirty-two-bit quantity, the second
--- a/src/sound.c	Thu May 05 16:55:41 2005 +0000
+++ b/src/sound.c	Thu May 05 17:10:54 2005 +0000
@@ -430,7 +430,7 @@
 sound symbols that map to other sounds should be considered abstract
 sounds, and are used when a particular behavior or state occurs.
 
-Rremember that the sound symbol is the *second* argument to `ding', not the
+Remember that the sound symbol is the *second* argument to `ding', not the
 first.
 
 The following abstract sounds are used by XEmacs itself: