aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChong Yidong2012-07-06 12:25:04 +0800
committerChong Yidong2012-07-06 12:25:04 +0800
commitd4913798ad8e836c8442e0df7f8f205beadba5d1 (patch)
tree78b0170ca02761001523766e145ea093b040ec0c
parent7dca65a4b4ff280171df473557d5fc0f98540200 (diff)
downloademacs-d4913798ad8e836c8442e0df7f8f205beadba5d1.tar.gz
emacs-d4913798ad8e836c8442e0df7f8f205beadba5d1.zip
Misc fixes for Lisp manual.
* doc/lispref/intro.texi (A Sample Function Description): Fix incorrect markup, undoing previous change. (A Sample Variable Description): Minor clarifications and markup improvements. * doc/lispref/elisp.texi (Top): * doc/lispref/text.texi (Text): Fix menu order.
-rw-r--r--doc/lispref/ChangeLog10
-rw-r--r--doc/lispref/elisp.texi2
-rw-r--r--doc/lispref/intro.texi53
-rw-r--r--doc/lispref/text.texi2
4 files changed, 39 insertions, 28 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 0fb57469f0f..62b86e756cf 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,13 @@
12012-07-06 Chong Yidong <cyd@gnu.org>
2
3 * intro.texi (A Sample Function Description): Fix incorrect
4 markup, undoing previous change.
5 (A Sample Variable Description): Minor clarifications and markup
6 improvements.
7
8 * elisp.texi (Top):
9 * text.texi (Text): Fix menu order.
10
12012-07-06 Richard Stallman <rms@gnu.org> 112012-07-06 Richard Stallman <rms@gnu.org>
2 12
3 * intro.texi (Evaluation Notation, A Sample Function Description): 13 * intro.texi (Evaluation Notation, A Sample Function Description):
diff --git a/doc/lispref/elisp.texi b/doc/lispref/elisp.texi
index 824934a5ceb..60abd718f8e 100644
--- a/doc/lispref/elisp.texi
+++ b/doc/lispref/elisp.texi
@@ -1123,9 +1123,9 @@ Text
1123* Case Changes:: Case conversion of parts of the buffer. 1123* Case Changes:: Case conversion of parts of the buffer.
1124* Text Properties:: Assigning Lisp property lists to text characters. 1124* Text Properties:: Assigning Lisp property lists to text characters.
1125* Substitution:: Replacing a given character wherever it appears. 1125* Substitution:: Replacing a given character wherever it appears.
1126* Transposition:: Swapping two portions of a buffer.
1127* Registers:: How registers are implemented. Accessing 1126* Registers:: How registers are implemented. Accessing
1128 the text or position stored in a register. 1127 the text or position stored in a register.
1128* Transposition:: Swapping two portions of a buffer.
1129* Base 64:: Conversion to or from base 64 encoding. 1129* Base 64:: Conversion to or from base 64 encoding.
1130* Checksum/Hash:: Computing cryptographic hashes. 1130* Checksum/Hash:: Computing cryptographic hashes.
1131* Parsing HTML/XML:: Parsing HTML and XML. 1131* Parsing HTML/XML:: Parsing HTML and XML.
diff --git a/doc/lispref/intro.texi b/doc/lispref/intro.texi
index a86079b1df2..d4877b50b62 100644
--- a/doc/lispref/intro.texi
+++ b/doc/lispref/intro.texi
@@ -379,24 +379,25 @@ More generally,
379@end example 379@end example
380@end defun 380@end defun
381 381
382 Any argument whose name contains the name of a type (e.g., 382 By convention, any argument whose name contains the name of a type
383@var{integer}, @var{integer1} or @var{buffer}) is expected to be of that 383(e.g.@: @var{integer}, @var{integer1} or @var{buffer}) is expected to
384type. A plural of a type (such as @var{buffers}) often means a list of 384be of that type. A plural of a type (such as @var{buffers}) often
385objects of that type. An argument named @var{object} may be of any type. 385means a list of objects of that type. An argument named @var{object}
386(For a list of Emacs object types, @pxref{Lisp Data Types}.) An argument 386may be of any type. (For a list of Emacs object types, @pxref{Lisp
387with some other sort of name (e.g., @var{new-file}) is discussed 387Data Types}.) An argument with any other sort of name
388specifically in the description of the function. In some sections, 388(e.g.@: @var{new-file}) is specific to the function; if the function
389features common to the arguments of several functions are described at 389has a documentation string, the type of the argument should be
390the beginning. 390described there (@pxref{Documentation}).
391 391
392 For a more complete description of arguments modified by 392 @xref{Lambda Expressions}, for a more complete description of
393@code{&optional} and @code{&rest}, @pxref{Lambda Expressions}. 393arguments modified by @code{&optional} and @code{&rest}.
394 394
395 Command, macro, and special form descriptions have the same format, 395 Command, macro, and special form descriptions have the same format,
396but the word `Function' is replaced by `Command', `Macro', or `Special 396but the word @samp{Function} is replaced by @samp{Command},
397Form', respectively. Commands are simply functions that may be called 397@samp{Macro}, or @samp{Special Form}, respectively. Commands are
398interactively; macros process their arguments differently from functions 398simply functions that may be called interactively; macros process
399(the arguments are not evaluated), but are presented the same way. 399their arguments differently from functions (the arguments are not
400evaluated), but are presented the same way.
400 401
401 The descriptions of macros and special forms use a more complex 402 The descriptions of macros and special forms use a more complex
402notation to specify optional and repeated arguments, because they can 403notation to specify optional and repeated arguments, because they can
@@ -445,14 +446,14 @@ from @var{body}, which includes all remaining elements of the form.
445@cindex variable descriptions 446@cindex variable descriptions
446@cindex option descriptions 447@cindex option descriptions
447 448
448 A @dfn{variable} is a name that can be bound to an object; binding 449 A @dfn{variable} is a name that can be @dfn{bound} (or @dfn{set}) to
449is frequently referred to as @dfn{setting}, and the object to which 450an object. The object to which a variable is bound is called a
450a variable is set is often called a @dfn{value} that the variable 451@dfn{value}; we say also that variable @dfn{holds} that value.
451@dfn{holds}. Although nearly all variables can be set by the user, 452Although nearly all variables can be set by the user, certain
452certain variables exist specifically so that users can change them; 453variables exist specifically so that users can change them; these are
453these are called @dfn{user options}. Ordinary variables and user 454called @dfn{user options}. Ordinary variables and user options are
454options are described using a format like that for functions, except 455described using a format like that for functions, except that there
455that there are no arguments. 456are no arguments.
456 457
457 Here is a description of the imaginary @code{electric-future-map} 458 Here is a description of the imaginary @code{electric-future-map}
458variable.@refill 459variable.@refill
@@ -463,8 +464,8 @@ Future mode. The functions in this map allow you to edit commands you
463have not yet thought about executing. 464have not yet thought about executing.
464@end defvar 465@end defvar
465 466
466 User option descriptions have the same format, but `Variable' is 467 User option descriptions have the same format, but @samp{Variable}
467replaced by `User Option'. 468is replaced by @samp{User Option}.
468 469
469@node Version Info 470@node Version Info
470@section Version Information 471@section Version Information
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi
index d670a85a464..c1e12ccf3a3 100644
--- a/doc/lispref/text.texi
+++ b/doc/lispref/text.texi
@@ -51,9 +51,9 @@ the character after point.
51* Case Changes:: Case conversion of parts of the buffer. 51* Case Changes:: Case conversion of parts of the buffer.
52* Text Properties:: Assigning Lisp property lists to text characters. 52* Text Properties:: Assigning Lisp property lists to text characters.
53* Substitution:: Replacing a given character wherever it appears. 53* Substitution:: Replacing a given character wherever it appears.
54* Transposition:: Swapping two portions of a buffer.
55* Registers:: How registers are implemented. Accessing the text or 54* Registers:: How registers are implemented. Accessing the text or
56 position stored in a register. 55 position stored in a register.
56* Transposition:: Swapping two portions of a buffer.
57* Base 64:: Conversion to or from base 64 encoding. 57* Base 64:: Conversion to or from base 64 encoding.
58* Checksum/Hash:: Computing cryptographic hashes. 58* Checksum/Hash:: Computing cryptographic hashes.
59* Parsing HTML/XML:: Parsing HTML and XML. 59* Parsing HTML/XML:: Parsing HTML and XML.