texinfo ChangeLog doc/texinfo.txi doc/refcard/M...

[karl]

CVSROOT:        /sources/texinfo
Module name:    texinfo
Changes by:     karl <karl>     12/09/21 17:40:45

Modified files:
        .              : ChangeLog 
        doc            : texinfo.txi 
        doc/refcard    : Makefile txicmdcheck txirefcard-a4.pdf 
                         txirefcard.pdf txivarcheck 

Log message:
        document remaining cust.vars

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texinfo/ChangeLog?cvsroot=texinfo&r1=1.1424&r2=1.1425
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/texinfo.txi?cvsroot=texinfo&r1=1.485&r2=1.486
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/refcard/Makefile?cvsroot=texinfo&r1=1.3&r2=1.4
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/refcard/txicmdcheck?cvsroot=texinfo&r1=1.6&r2=1.7
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/refcard/txirefcard-a4.pdf?cvsroot=texinfo&rev=1.16
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/refcard/txirefcard.pdf?cvsroot=texinfo&rev=1.16
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/refcard/txivarcheck?cvsroot=texinfo&r1=1.2&r2=1.3

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/texinfo/texinfo/ChangeLog,v
retrieving revision 1.1424
retrieving revision 1.1425
diff -u -b -r1.1424 -r1.1425
--- ChangeLog   15 Sep 2012 18:06:52 -0000      1.1424
+++ ChangeLog   21 Sep 2012 17:40:29 -0000      1.1425
@@ -1,3 +1,13 @@
+2012-09-21  Karl Berry  <address@hidden>
+
+       * doc/refcard/Makefile (ccheck, vcheck): pass txi_check_args
+       (from environment), for my cron.
+       * doc/refcard/ccheck: recognize --no-common to output only problems.
+       * doc/refcard/vcheck: likewise, and omit OUTPUT_PERL_ENCODING from
+       check.
+       * doc/texinfo.txi (Other Customization Variables): document
+       remaining variables.
+
 2012-09-15  Patrice Dumas  <address@hidden>
 
        * doc/texinfo.txi (texi2any Output Customization): remove 

Index: doc/texinfo.txi
===================================================================
RCS file: /sources/texinfo/texinfo/doc/texinfo.txi,v
retrieving revision 1.485
retrieving revision 1.486
diff -u -b -r1.485 -r1.486
--- doc/texinfo.txi     15 Sep 2012 18:06:52 -0000      1.485
+++ doc/texinfo.txi     21 Sep 2012 17:40:40 -0000      1.486
@@ -1,5 +1,5 @@
 \input texinfo.tex    @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.485 2012/09/15 18:06:52 pertusus Exp $
address@hidden $Id: texinfo.txi,v 1.486 2012/09/21 17:40:40 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.
 
@@ -17228,6 +17228,7 @@
 @smallexample
 @@allowcodebreaks @@clickstyle @@codequotebacktick 
 @@codequoteundirected @@contents @@deftypefnnewline
+@@documentdescription
 @@documentencoding @@documentlanguage
 @@evenfootingmarks @@evenheadingmarks @@everyfootingmarks 
 @@everyheadingmarks @@exampleindent @@firstparagraphindent
@@ -17235,13 +17236,17 @@
 @@kbdinputstyle @@novalidate @@oddfootingmarks
 @@oddheadingmarks @@pagesizes @@paragraphindent
 @@setchapternewpage @@setcontentsaftertitlepage
+@@setfilename
 @@setshortcontentsaftertitlepage @@shortcontents
 @@urefbreakstyle @@xrefautomaticsectiontitle
 @end smallexample
address@hidden @@setfilename
 
-Setting such a customization variable to a value @samp{foo} is
-essentially the same as executing @code{@@@var{cmd} foo}.
+Setting such a customization variable to a value @samp{foo} is similar
+to executing @code{@@@var{cmd} foo}.  It is not exactly the same,
+though, since any side effects of parsing the Texinfo source are not
+redone.  Also, some variables do not take Texinfo code when generating
+particular formats, but an argument that is already formatted.  This
+is the case, for example, for HTML for @code{documentdescription}.
 
 
 @node Customization Variables and Options
@@ -17292,10 +17297,14 @@
                                         @code{SUBDIR}
 @vindex paragraphindent
 @item @option{--paragraph-indent}  @tab @code{paragraphindent}
address@hidden SILENT
address@hidden @option{--silent}            @tab @code{SILENT}
 @vindex SPLIT
 @item @option{--split}             @tab @code{SPLIT}
 @vindex SPLIT_SIZE
 @item @option{--split-size}        @tab @code{SPLIT_SIZE}
address@hidden TRANSLITERATE_FILE_NAMES
address@hidden @option{--transliterate-file-names} @tab 
@code{TRANSLITERATE_FILE_NAMES}
 @vindex VERBOSE
 @item @option{--verbose}           @tab @code{VERBOSE}
 @end multitable
@@ -17329,7 +17338,7 @@
 used.
 
 @item BASEFILENAME_LENGTH
-For address@hidden  The maximum length of the base filenames.  Default 245.
+For address@hidden  The maximum length of the base filenames; default 245.
 Changing this would make cross-manual references to such long node
 names invalid (@pxref{HTML Xref Link Basics}).
 
@@ -17351,14 +17360,19 @@
 
 @item CASE_INSENSITIVE_FILENAMES
 For address@hidden  Construct output file names as if the filesystem were case
-insensitive (@pxref{HTML Splitting}). 
+insensitive (@pxref{HTML Splitting}); default false.
 
 @item CHAPTER_HEADER_LEVEL
 For address@hidden  Header formatting level used for chapter level sectioning
 commands.
 
address@hidden CHECK_HTMLXREF
+For address@hidden  Check that manuals which are the target of external
+cross references (@pxref{Four and Five Arguments}) are present in
address@hidden (@pxref{HTML Xref Configuration}); on by default.
+
 @item CLOSE_QUOTE_SYMBOL
-When a closing quote is needed, use the corresponding character.
+When a closing quote is needed, use this character.
 
 @c @item COMPLETE_IMAGE_PATHS
 @c If set, the image files are computed to be relative from the document
@@ -17369,17 +17383,16 @@
 
 @item CPP_LINE_DIRECTIVES
 Recognize @code{#line} directives in a ``preprocessing'' pass
-(@pxref{External Macro Processors}).
+(@pxref{External Macro Processors}); on by default;
 
 @item CSS_LINES
-CSS output, automatically determined in the default case
-(@pxref{HTML CSS}).
+For address@hidden  CSS output, automatically determined by default 
(@pxref{HTML CSS}).
 
 @item DATE_IN_HEADER
-For address@hidden  Put the document generation date in the header.
+For address@hidden  Put the document generation date in the header; off by 
default.
 
 @item DEBUG
-If set, debugging output is generated.
+If set, debugging output is generated; default is off (zero).
 @c The integer value specifies what kinds of debugging output are
 @c generated.  It is a bitmask.  Setting it to 255 ensures having all
 @c available debugging output.
@@ -17393,14 +17406,10 @@
 For address@hidden  Rule used between element, except after and before the 
 top element, or before special elements, and for footers and headers.
 
address@hidden not used for now
address@hidden @item DEFAULT_ENCODING
address@hidden The default output file encoding.  Currently @samp{utf8} or
address@hidden @samp{ascii} for Info.
-
 @item DO_ABOUT
 If set to 0 never do an About special element.
-If set to 1 always do an About special element. @c @xref{Output Elements 
Defined}.
+If set to 1 always do an About special element.
address@hidden @xref{Output Elements Defined}.
 
 @item DOCTYPE
 @vindex SystemLiteral
@@ -17423,11 +17432,6 @@
 entity corresponding with the letter or the symbol being output,
 prefer the entity.
 
address@hidden @item ENCODING_NAME
address@hidden Output document encoding name. By default, it is set 
automatically
address@hidden based on @code{@@documentencoding}.  This encoding name is the
address@hidden classical charset name in HTML.
-
 @item EXTERNAL_CROSSREF_SPLIT
 For cross references to other manuals, this determines if the other
 manual is considered to be split or monolithic.  By default, it is set
@@ -17498,9 +17502,6 @@
 @item INDEX_ENTRY_COLON
 Symbol used between the index entry and the associated node or section.
 
address@hidden @item IN_ENCODING
address@hidden Set the input file encoding (@pxref{documentencoding,,
address@hidden @code{@@documentencoding}}) using Perl encoding names.
 
 @item INLINE_CONTENTS
 If set, output the contents where the @code{@@contents} and similar
@@ -17516,6 +17517,17 @@
 content (@pxref{copying,, @code{@@copying}}) as if
 @code{@@insertcopying} were a user-defined macro.
 
address@hidden INPUT_ENCODING_NAME
+Normalized encoding name suitable for output.  Should be a usable
+charset name in HTML, typically one of the preferred IANA encoding
+names.  You should not need to use this variable, since it is set by
address@hidden@@documentencoding} (@pxref{documentencoding}).
+
address@hidden INPUT_PERL_ENCODING
+Perl encoding used to process the Texinfo source.  You should not need
+to use that variable, since it is set by @code{@@documentencoding}
+(@pxref{documentencoding}).
+
 @item KEEP_TOP_EXTERNAL_REF
 For address@hidden  If set, do not ignore @samp{Top} as the first 
 argument for an external ref to a manual, as is done by default.
@@ -17597,9 +17609,23 @@
 @item OPEN_QUOTE_SYMBOL
 When an opening quote is needed, use the corresponding character.
 
address@hidden OUT_ENCODING
-Output files encoding using the Perl encoding name.  By default,
-this is set automatically based on @code{@@documentencoding}.
address@hidden item OUTPUT_PERL_ENCODING
address@hidden Perl encoding name used for the output files. By default, this 
is set
address@hidden automatically based on @code{@@documentencoding} or
address@hidden ode{OUTPUT_ENCODING_NAME}.  You should never need to set this
address@hidden ustomization variable, instead, you should set
address@hidden ode{OUTPUT_ENCODING_NAME}.
+
address@hidden OUTPUT_ENCODING_NAME
+Normalized encoding name used for output files.  Should be a usable
+charset name in HTML, typically one of the preferred IANA encoding
+names.  By default, if an input encoding is set, typically through
address@hidden@@documentencoding} or @code{INPUT_ENCODING_NAME}, this
+information is used to set the output encoding name.  If no input
+encoding is specified, the default output encoding name may be set by
+the output format.  In particular, the XML-based formats use
address@hidden for @code{OUTPUT_ENCODING_NAME} if the encoding is not
+otherwise specified.
 
 @item OVERVIEW_LINK_TO_TOC
 If set, the cross references in the Overview link to the corresponding
@@ -17717,6 +17743,10 @@
 @item TOP_NODE_UP
 Up node for the Top node; default @samp{(dir)}.
 
address@hidden TOP_NODE_UP_URL
+Url used for the up node of the Top node for HTML; default
address@hidden, so no link is generated.
+
 @item TOP_NODE_FILE
 File used for the Top node, if @code{NODE_FILENAMES} is set.
 
@@ -21573,7 +21603,7 @@
 or other version control systems, which expand it into a string such
 as:
 @example
-$Id: texinfo.txi,v 1.485 2012/09/15 18:06:52 pertusus Exp $
+$Id: texinfo.txi,v 1.486 2012/09/21 17:40:40 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}

Index: doc/refcard/Makefile
===================================================================
RCS file: /sources/texinfo/texinfo/doc/refcard/Makefile,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -b -r1.3 -r1.4
--- doc/refcard/Makefile        12 Sep 2012 18:15:43 -0000      1.3
+++ doc/refcard/Makefile        21 Sep 2012 17:40:44 -0000      1.4
@@ -1,4 +1,4 @@
-# $Id: Makefile,v 1.3 2012/09/12 18:15:43 karl Exp $
+# $Id: Makefile,v 1.4 2012/09/21 17:40:44 karl Exp $
 # Makefile for texinfo/doc/refcard.
 # This is not hooked into Automake, just here for those working on the refcard.
 #
@@ -31,10 +31,10 @@
 check: ccheck vcheck
 
 ccheck:
-       txicmdcheck
+       txicmdcheck $(txi_check_args)
 
 vcheck:
-       txivarcheck
+       txivarcheck $(txi_check_args)
 
 clean:
        rm -f $(doc)*.dvi $(doc)*.log $(doc)*.ps

Index: doc/refcard/txicmdcheck
===================================================================
RCS file: /sources/texinfo/texinfo/doc/refcard/txicmdcheck,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -b -r1.6 -r1.7
--- doc/refcard/txicmdcheck     14 Sep 2012 18:18:06 -0000      1.6
+++ doc/refcard/txicmdcheck     21 Sep 2012 17:40:45 -0000      1.7
@@ -1,5 +1,5 @@
 #!/usr/bin/env perl
-# $Id: txicmdcheck,v 1.6 2012/09/14 18:18:06 karl Exp $
+# $Id: txicmdcheck,v 1.7 2012/09/21 17:40:45 karl Exp $
 # Copyright 2008, 2011, 2012 Free Software Foundation, Inc.
 # 
 # This program is free software; you can redistribute it and/or modify
@@ -23,6 +23,8 @@
 exit (&main ());
 
 sub main {
+  my $no_common = $ARGV[0] eq "--no-common";
+
   my @card_cmds = &read_refcard ("txirefcard.tex");
   my @man_cmds = &read_refman ("../texinfo.txi");
   my @tp_cmds = &read_tp ("../../util/txicmdlist");
@@ -42,7 +44,8 @@
     }
   }
   
-  printf "    common %d: @{[sort @found]}\n", @found + 0;
+  printf ("    common %d: @{[sort @found]}\n", @found + 0)
+    unless $no_common;
 
   my @card_only = keys %card_cmds;
   printf "refcard only %s: @{[sort @card_only]}\n", @card_only + 0;

Index: doc/refcard/txirefcard-a4.pdf
===================================================================
RCS file: /sources/texinfo/texinfo/doc/refcard/txirefcard-a4.pdf,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -b -r1.15 -r1.16
Binary files /tmp/cvszFNwXX and /tmp/cvsqR508U differ

Index: doc/refcard/txirefcard.pdf
===================================================================
RCS file: /sources/texinfo/texinfo/doc/refcard/txirefcard.pdf,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -b -r1.15 -r1.16
Binary files /tmp/cvsqXmDC1 and /tmp/cvsKU0PQY differ

Index: doc/refcard/txivarcheck
===================================================================
RCS file: /sources/texinfo/texinfo/doc/refcard/txivarcheck,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -b -r1.2 -r1.3
--- doc/refcard/txivarcheck     12 Sep 2012 22:23:10 -0000      1.2
+++ doc/refcard/txivarcheck     21 Sep 2012 17:40:45 -0000      1.3
@@ -1,5 +1,5 @@
 #!/usr/bin/env perl
-# $Id: txivarcheck,v 1.2 2012/09/12 22:23:10 pertusus Exp $
+# $Id: txivarcheck,v 1.3 2012/09/21 17:40:45 karl Exp $
 # Copyright 2012 Free Software Foundation, Inc.
 # 
 # This program is free software; you can redistribute it and/or modify
@@ -25,6 +25,8 @@
 exit (&main ());
 
 sub main {
+  my $no_common = $ARGV[0] eq "--no-common";
+  
   my @man_vars = &read_refman ("../texinfo.txi");
   my @tp_vars = &read_tp ("../../util/txicustomvars");
 
@@ -41,7 +43,8 @@
     }
   }
   
-  printf "common %3d: @{[sort @found]}\n", @found + 0;
+  printf ("common %3d: @{[sort @found]}\n", @found + 0)
+    unless $no_common;
 
   # we can't report variable names only in the manual, since our list
   # necessarily includes many non-variables.
@@ -113,7 +116,9 @@
   while (<FILE>) {
     chomp;
     my ($var,$where) = split (/\t/);
-    next if ($where eq 'variable_other_settables' or $where eq 
'parser_options');
+    next if ($where eq 'variable_other_settables'
+             || $where eq 'parser_options');
+    next if $var eq "OUTPUT_PERL_ENCODING";
     push (@ret, $var);
   }
   close (FILE) || warn "close($FILE) failed: $!";