summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2012-12-29 10:23:21 +0200
committerEli Zaretskii <eliz@gnu.org>2012-12-29 10:23:21 +0200
commit151d90884b7d06bf842273661f3c41b086bd5c3d (patch)
tree641251024bd619991f851778014db0fc38e6c7a4
parent3ee24a3b32543fa4cf4a2102082491cf6bcb45c5 (diff)
downloademacs-151d90884b7d06bf842273661f3c41b086bd5c3d.tar.gz
Fix bug #13292 with use of @var in @def.. commands in ELisp manual.
doc/lispref/functions.texi (Declare Form): doc/lispref/intro.texi (A Sample Function Description): doc/lispref/syntax.texi (Syntax Table Internals, Syntax Table Functions): doc/lispref/variables.texi (Using Lexical Binding): Don't use @var or CAPS in @def.. commands.
-rw-r--r--doc/lispref/ChangeLog8
-rw-r--r--doc/lispref/functions.texi2
-rw-r--r--doc/lispref/intro.texi2
-rw-r--r--doc/lispref/syntax.texi4
-rw-r--r--doc/lispref/variables.texi2
5 files changed, 13 insertions, 5 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index f77e68aadc4..a52268fc7e7 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,11 @@
+2012-12-29 Wolfgang Jenkner <wjenkner@inode.at>
+
+ * functions.texi (Declare Form):
+ * intro.texi (A Sample Function Description):
+ * syntax.texi (Syntax Table Internals, Syntax Table Functions):
+ * variables.texi (Using Lexical Binding): Don't use @var or CAPS
+ in @def.. commands. (Bug#13292)
+
2012-12-27 Glenn Morris <rgm@gnu.org>
* files.texi (File Names): Mention Cygwin conversion functions.
diff --git a/doc/lispref/functions.texi b/doc/lispref/functions.texi
index 531172031dc..10041bb664a 100644
--- a/doc/lispref/functions.texi
+++ b/doc/lispref/functions.texi
@@ -1266,7 +1266,7 @@ obsolete, or giving its forms a special @key{TAB} indentation
convention in Emacs Lisp mode.
@anchor{Definition of declare}
-@defmac declare @var{specs}@dots{}
+@defmac declare specs@dots{}
This macro ignores its arguments and evaluates to @code{nil}; it has
no run-time effect. However, when a @code{declare} form occurs in the
@var{declare} argument of a @code{defun} or @code{defsubst} function
diff --git a/doc/lispref/intro.texi b/doc/lispref/intro.texi
index 12463dac09c..bee43a9bc3f 100644
--- a/doc/lispref/intro.texi
+++ b/doc/lispref/intro.texi
@@ -408,7 +408,7 @@ stands for zero or more arguments. Parentheses are used when several
arguments are grouped into additional levels of list structure. Here
is an example:
-@defspec count-loop (@var{var} [@var{from} @var{to} [@var{inc}]]) @var{body}@dots{}
+@defspec count-loop (var [from to [inc]]) body@dots{}
This imaginary special form implements a loop that executes the
@var{body} forms and then increments the variable @var{var} on each
iteration. On the first iteration, the variable has the value
diff --git a/doc/lispref/syntax.texi b/doc/lispref/syntax.texi
index c773ca74d96..777bae6573b 100644
--- a/doc/lispref/syntax.texi
+++ b/doc/lispref/syntax.texi
@@ -506,7 +506,7 @@ This function returns the current syntax table, which is the table for
the current buffer.
@end defun
-@defmac with-syntax-table @var{table} @var{body}@dots{}
+@defmac with-syntax-table table body@dots{}
This macro executes @var{body} using @var{table} as the current syntax
table. It returns the value of the last form in @var{body}, after
restoring the old current syntax table.
@@ -998,7 +998,7 @@ corresponds to each syntax flag.
@samp{4} @tab @code{(lsh 1 19)}
@end multitable
-@defun string-to-syntax @var{desc}
+@defun string-to-syntax desc
Given a syntax descriptor @var{desc} (a string), this function returns
the corresponding raw syntax descriptor.
@end defun
diff --git a/doc/lispref/variables.texi b/doc/lispref/variables.texi
index 4103c30f663..79f5eaa7c26 100644
--- a/doc/lispref/variables.texi
+++ b/doc/lispref/variables.texi
@@ -1057,7 +1057,7 @@ variables}. Every variable that has been defined with @code{defvar},
(@pxref{Defining Variables}). All other variables are subject to
lexical binding.
-@defun special-variable-p SYMBOL
+@defun special-variable-p symbol
This function returns non-@code{nil} if @var{symbol} is a special
variable (i.e., it has a @code{defvar}, @code{defcustom}, or
@code{defconst} variable definition). Otherwise, the return value is