texinfo-commits
[Top][All Lists]
Advanced

[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: Fri, 08 Oct 2010 23:28:30 +0000

CVSROOT:        /sources/texinfo
Module name:    texinfo
Changes by:     Karl Berry <karl>       10/10/08 23:28:30

Modified files:
        .              : ChangeLog 
        doc            : texinfo.txi 

Log message:
        user command names

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texinfo/ChangeLog?cvsroot=texinfo&r1=1.1153&r2=1.1154
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/texinfo.txi?cvsroot=texinfo&r1=1.324&r2=1.325

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/texinfo/texinfo/ChangeLog,v
retrieving revision 1.1153
retrieving revision 1.1154
diff -u -b -r1.1153 -r1.1154
--- ChangeLog   7 Oct 2010 12:24:07 -0000       1.1153
+++ ChangeLog   8 Oct 2010 23:28:29 -0000       1.1154
@@ -1,3 +1,10 @@
+2010-10-08  Karl Berry  <address@hidden>
+
+       * doc/texinfo.txi (Defining Macros),
+       (alias),
+       (set value): more precisely document naming recommendations
+       and requirements.
+
 2010-10-07  Sergey Poznyakoff  <address@hidden>
 
        * info/nodes.c (info_node_of_file_buffer_tags): Check if

Index: doc/texinfo.txi
===================================================================
RCS file: /sources/texinfo/texinfo/doc/texinfo.txi,v
retrieving revision 1.324
retrieving revision 1.325
diff -u -b -r1.324 -r1.325
--- doc/texinfo.txi     1 Oct 2010 18:05:23 -0000       1.324
+++ doc/texinfo.txi     8 Oct 2010 23:28:29 -0000       1.325
@@ -1,5 +1,5 @@
 \input texinfo.tex    @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.324 2010/10/01 18:05:23 karl Exp $
address@hidden $Id: texinfo.txi,v 1.325 2010/10/08 23:28:29 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.
 
@@ -7380,7 +7380,7 @@
 @cindex Command names, indicating
 @cindex Program names, indicating
 
-Use the @code{@@commannd} command to indicate command names, such as
+Use the @code{@@command} command to indicate command names, such as
 @command{ls} or @command{cc}.
 
 @code{@@command} is equivalent to @code{@@code} in its effects.
@@ -10180,7 +10180,7 @@
 @@defindex @var{name}
 @end example
 
-The name of an index should be a two letter word, such as @samp{au}.
+The name of an index should be a two-letter word, such as @samp{au}.
 For example:
 
 @example
@@ -13546,7 +13546,8 @@
 You use the @code{@@set} command to specify a value for a flag, which
 is later expanded by the @code{@@value} command.
 
-A @dfn{flag} (aka @dfn{variable}) is an identifier.  It is best to use
+A @dfn{flag} (aka @dfn{variable}) is an identifier consisting of
+alphanumerics, @samp{-}, and @samp{_}.  However, it is best to use
 only letters and numerals in a flag name, not @samp{-} or
 @samp{_}---they will work in some contexts, but not all, due to
 limitations in @TeX{}.
@@ -14091,10 +14092,10 @@
 For a macro to work consistently with @TeX{}, @var{macroname} must
 consist entirely of letters: no digits, hyphens, underscores, or other
 special characters.  So, we recommend using only letters.  However,
address@hidden will accept anything except @address@hidden@}_^=};
address@hidden and @samp{^} are excluded so that macros can be called in
address@hidden@@math} mode without a following space
-(@pxref{math,,@code{@@math}}).
address@hidden will accept anything consisting of alphanumerics,
+and (except as the first character) @samp{-}.  The @samp{_} character
+is excluded so that macros can be called inside @code{@@math} without
+a following space (@pxref{math,,@code{@@math}}).
 
 If a macro needs no parameters, you can define it either with an empty
 list (@samp{@@macro foo @address@hidden) or with no braces at all 
(@samp{@@macro
@@ -14490,9 +14491,14 @@
 
 Aliases must not be recursive, directly or indirectly.
 
-It is not advisable to redefine any @TeX{} primitive, plain, or
+It is not advisable to redefine any @TeX{} primitive, plain @TeX{}, or
 Texinfo command name as an alias.  Unfortunately this is a very large
-set of names, and the possible resulting errors are completely random.
+set of names, and the possible resulting errors from @TeX{} are
+completely unpredictable.
+
address@hidden will accept anything for an alias name consisting
+of alphanumerics, @samp{_}, and (except as the first character)
address@hidden
 
 
 @node definfoenclose
@@ -24654,7 +24660,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.324 2010/10/01 18:05:23 karl Exp $
+$Id: texinfo.txi,v 1.325 2010/10/08 23:28:29 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}
@@ -24733,7 +24739,7 @@
 
 @verbatim
 \input texinfo   @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.324 2010/10/01 18:05:23 karl Exp $
address@hidden $Id: texinfo.txi,v 1.325 2010/10/08 23:28:29 karl Exp $
 @comment %**start of header
 @setfilename sample.info
 @include version.texi



reply via email to

[Prev in Thread] Current Thread [Next in Thread]