[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
texinfo ChangeLog doc/texinfo.txi
From: |
Karl Berry |
Subject: |
texinfo ChangeLog doc/texinfo.txi |
Date: |
Mon, 15 Nov 2010 01:18:44 +0000 |
CVSROOT: /sources/texinfo
Module name: texinfo
Changes by: Karl Berry <karl> 10/11/15 01:18:44
Modified files:
. : ChangeLog
doc : texinfo.txi
Log message:
(Invoking Macros): attempt to clarify calling without braces
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texinfo/ChangeLog?cvsroot=texinfo&r1=1.1178&r2=1.1179
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/texinfo.txi?cvsroot=texinfo&r1=1.349&r2=1.350
Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/texinfo/texinfo/ChangeLog,v
retrieving revision 1.1178
retrieving revision 1.1179
diff -u -b -r1.1178 -r1.1179
--- ChangeLog 11 Nov 2010 19:12:16 -0000 1.1178
+++ ChangeLog 15 Nov 2010 01:18:43 -0000 1.1179
@@ -1,3 +1,9 @@
+2010-11-14 Karl Berry <address@hidden>
+
+ * doc/texinfo.txi (Invoking Macros): attempt to clarify
+ calling without braces (only allowed if the macro takes exactly
+ one arg), and leaving arguments out (ok).
+
2010-11-11 Karl Berry <address@hidden>
* doc/texinfo.txi (Macro Details): mention non-expansion contexts
Index: doc/texinfo.txi
===================================================================
RCS file: /sources/texinfo/texinfo/doc/texinfo.txi,v
retrieving revision 1.349
retrieving revision 1.350
diff -u -b -r1.349 -r1.350
--- doc/texinfo.txi 14 Nov 2010 18:24:18 -0000 1.349
+++ doc/texinfo.txi 15 Nov 2010 01:18:43 -0000 1.350
@@ -1,5 +1,5 @@
\input texinfo.tex @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.349 2010/11/14 18:24:18 karl Exp $
address@hidden $Id: texinfo.txi,v 1.350 2010/11/15 01:18:43 karl Exp $
@c Ordinarily, Texinfo files have the extension .texi. But texinfo.texi
@c clashes with texinfo.tex on 8.3 filesystems, so we use texinfo.txi.
@@ -14222,6 +14222,7 @@
@node Invoking Macros
@section Invoking Macros
+
@cindex Invoking macros
@cindex Expanding macros
@cindex Running macros
@@ -14354,9 +14355,11 @@
or incorrect output (the @samp{\} ``escape'' being included
literally) are likely to result.
-If the macro is defined to take a single argument, and is invoked
-without any braces, the entire rest of the line after the macro name is
-supplied as the argument. For example:
+If the macro is defined to take exactly one argument, and is invoked
+without any braces, the entire rest of the line after the macro name
+is supplied as the argument. (It's an error to specify the argument
+without braces if the macro takes either zero or more than one
+argument.) For example:
@example
@@macro bar @address@hidden
@@ -14372,8 +14375,8 @@
Twice: aah & aah.
@end display
-If the macro is defined to take a single argument, and is invoked with
-braces, the braced text is passed as the argument, regardless of
+If the macro is defined to take exactly one argument, and is invoked
+with braces, the braced text is passed as the argument, regardless of
commas. For example:
@example
@@ -14389,6 +14392,23 @@
Twice: a,b & a,b.
@end display
+If a macro is defined to take more than one argument, but is called
+with only one (in braces), the remaining arguments are set to the
+empty string, and no error is given. For example:
+
address@hidden
+@@macro addtwo @{p, address@hidden
+Both: \p\\q\.
+@@end macro
+@@address@hidden@}
address@hidden example
+
address@hidden produces simply:
+
address@hidden
+Both: a.
address@hidden display
+
@node Macro Details
@section Macro Details and Caveats
@@ -22919,7 +22939,7 @@
(@url{http://www.gnu.org/software/rcs}) version control systems, which
expand it into a string such as:
@example
-$Id: texinfo.txi,v 1.349 2010/11/14 18:24:18 karl Exp $
+$Id: texinfo.txi,v 1.350 2010/11/15 01:18:43 karl Exp $
@end example
(This is useful in all sources that use version control, not just manuals.)
You may wish to include the @samp{$Id:} comment in the @code{@@copying}
@@ -22998,7 +23018,7 @@
@verbatim
\input texinfo @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.349 2010/11/14 18:24:18 karl Exp $
address@hidden $Id: texinfo.txi,v 1.350 2010/11/15 01:18:43 karl Exp $
@comment %**start of header
@setfilename sample.info
@include version.texi
- texinfo ChangeLog doc/texinfo.txi,
Karl Berry <=