texinfo ChangeLog doc/texinfo.txi texi2html/Cha...

[Karl Berry]

CVSROOT:        /sources/texinfo
Module name:    texinfo
Changes by:     Karl Berry <karl>       10/07/19 18:28:11

Modified files:
        .              : ChangeLog 
        doc            : texinfo.txi 
        texi2html      : ChangeLog texi2html.pl 

Log message:
        doc for noderename.cnf

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texinfo/ChangeLog?cvsroot=texinfo&r1=1.1063&r2=1.1064
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/texinfo.txi?cvsroot=texinfo&r1=1.258&r2=1.259
http://cvs.savannah.gnu.org/viewcvs/texinfo/texi2html/ChangeLog?cvsroot=texinfo&r1=1.526&r2=1.527
http://cvs.savannah.gnu.org/viewcvs/texinfo/texi2html/texi2html.pl?cvsroot=texinfo&r1=1.405&r2=1.406

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/texinfo/texinfo/ChangeLog,v
retrieving revision 1.1063
retrieving revision 1.1064
diff -u -b -r1.1063 -r1.1064
--- ChangeLog   18 Jul 2010 23:01:02 -0000      1.1063
+++ ChangeLog   19 Jul 2010 18:28:09 -0000      1.1064
@@ -1,3 +1,8 @@
+2010-07-19  Karl Berry  <address@hidden>
+
+       * doc/texinfo.txi (HTML Xref Link Preservation): new node
+       about the MANUAL-noderename.cnf file.
+
 2010-07-19  Patrice Dumas  <address@hidden>
 
        * doc/texinfo.txi (Generic converter texi2any/makeinfo): add a

Index: doc/texinfo.txi
===================================================================
RCS file: /sources/texinfo/texinfo/doc/texinfo.txi,v
retrieving revision 1.258
retrieving revision 1.259
diff -u -b -r1.258 -r1.259
--- doc/texinfo.txi     18 Jul 2010 23:01:02 -0000      1.258
+++ doc/texinfo.txi     19 Jul 2010 18:28:10 -0000      1.259
@@ -1,5 +1,5 @@
 \input texinfo.tex    @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.258 2010/07/18 23:01:02 pertusus Exp $
address@hidden $Id: texinfo.txi,v 1.259 2010/07/19 18:28:10 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.
 
@@ -605,7 +605,7 @@
 * Invoking texi2any::           How to run @command{texi2any} and 
@command{makeinfo} 
                                 from a shell.
 * Pointer Validation::          How to check that pointers point somewhere.
-* Configuration variables::     Description of configuration variables.
+* makeinfo Configuration Variables:: Description of configuration variables.
 
 Creating and Installing Info Files
 
@@ -647,6 +647,8 @@
 * Command Expansion: HTML Xref Command Expansion.
 * 8-bit Expansion:   HTML Xref 8-bit Character Expansion.
 * Mismatch:          HTML Xref Mismatch.
+* Configuration:     HTML Xref Configuration.      htmlxref.cnf.
+* Preserving links:  HTML Xref Link Preservation.  MANUAL-noderename.cnf.
 
 @@-Command List
 
@@ -15919,7 +15921,7 @@
 * Invoking texi2any::           How to run @command{texi2any} or 
@command{makeinfo} 
                                 from a shell.
 * Pointer Validation::          How to check that pointers point somewhere.
-* Configuration variables::     Description of configuration variables.
+* makeinfo Configuration Variables:: Description of configuration variables.
 @end menu
 
 @node Invoking texi2any
@@ -16448,8 +16450,9 @@
 address@hidden
 @end enumerate
 
address@hidden Configuration variables
address@hidden Configuration variables
+
address@hidden makeinfo Configuration Variables
address@hidden @code{makeinfo} Configuration Variables
 
 Many aspects of the behaviour and output may be modified by modifying 
 configuration variables. 
@@ -16724,31 +16727,42 @@
 If set, node names are used to construct file names. In the 
 default case, it is set if split at node, or @code{NODE_FILES} is set
 and document is split.
+
 @item DEFAULT_ENCODING
 The default out file encoding. Currently @samp{utf8} or @samp{ascii} for Info.
+
 @item OUT_ENCODING
 Output files encoding using perl encoding name. In the default
 case set auotmatically based on @code{@@documentencoding}.
+
 @item ENCODING_NAME
 Output document encoding. In the default case set automatically
 based on @code{@@documentencoding}. This encoding name is
 the 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. In the default case
-set based on @code{SPLIT}. @xref{HTML Xref}. @xref{HTML Xref Configuration}.
+set based on @code{SPLIT}. @xref{HTML Xref}, and see @ref{HTML Xref
+Configuration}.
+
 @item BODYTEXT
 For HTML.  The text appearing in @code{<body>}.  Set automatically
 taking into account the document language in the default case.
+
 @item CSS_LINES
 Lines of CSS, automatically determined in the default 
 case.  @xref{HTML CSS}.
+
 @item RENAMED_NODES_REDIRECTIONS
 If set do redirection files for renamed nodes. Set for HTML in the
 default case.
+
 @item RENAMED_NODES_FILE
 Use the value for the renamed nodes description file. If not set, the 
-file is @file{<input_file_basename>-noderename.cnf}.
+file is @file{<input_file_basename>-noderename.cnf}.  @xref{HTML Xref
+Link Preservation}.
+
 @end vtable
 
 @menu
@@ -17911,7 +17925,8 @@
 * Command Expansion: HTML Xref Command Expansion.
 * 8-bit Expansion:   HTML Xref 8-bit Character Expansion.
 * Mismatch:          HTML Xref Mismatch.
-* Configuration:     HTML Xref Configuration.
+* Configuration:     HTML Xref Configuration.      htmlxref.cnf.
+* Preserving links:  HTML Xref Link Preservation.  MANUAL-noderename.cnf.
 @end menu
 
 
@@ -18375,10 +18390,10 @@
 When available, @command{makeinfo} will use the ``corresponding''
 value for cross-references between manuals.  That is, when generating
 monolithic output (@option{--no-split}), the @code{mono} url will be
-used, when generating output split by node, the @code{node} url will
-be used, etc.  However, if a manual is not available in that form,
-whatever is available will be used.  Here is the search order for each
-style that can be generated:
+used, when generating output that is split by node, the @code{node}
+url will be used, etc.  However, if a manual is not available in that
+form, whatever is available will be used.  Here is the search order
+for each style that can be generated:
 
 @smallexample
 node    => node,    section, chapter, mono
@@ -18390,7 +18405,7 @@
 @opindex address@hidden, and HTML cross-references}
 These section- and chapter-level cross-manual references can succeed
 only when the target manual was created using @option{--node-files},
-which is the default for @code{makeinfo}.
+which is the default.
 
 If you have additions or corrections to the @file{htmlxref.cnf}
 distributed with Texinfo, please email @email{bug-texinfo@@gnu.org}.
@@ -18398,6 +18413,53 @@
 @url{http://ftpmirror.gnu.org/@/texinfo/@/htmlxref.cnf}.
 
 
address@hidden HTML Xref Link Preservation
address@hidden HTML Cross-reference Link Preservation: @address@hidden
+
address@hidden noderename.cnf
address@hidden @var{manual}-noderename.cnf
address@hidden HTML cross-reference link preservation
address@hidden Preserving HTML links to old nodes
address@hidden Old nodes, preserving links to
address@hidden Renaming nodes, and preserving links
address@hidden Links, preserving to renamed nodes
+
+Occasionally changes in a program require removing (or renaming) nodes
+in the manual in order to have the best documentation.  Given the
+nature of the web, however, links may exist anywhere to any such
+removed node (renaming appears the same as removal for this purpose),
+and it's not ideal for those links to simply break.
+
+Therefore, Texinfo provides a way for manual authors to specify old
+node names and the new nodes to which the old names should be
+redirected, via the file @address@hidden, where
address@hidden is the base name of the manual.  For example, the manual
address@hidden would be supplemented by a file
address@hidden  (This name can be overridden by
+setting the @file{RENAMED_NODES_FILE} configuration variable;
address@hidden Configuration Variables}).
+
+The file is read in pairs of lines, as follows:
+
address@hidden
address@hidden
+@@@@@address@hidden @var{new-node-name}
address@hidden example
+
+The usual conversion from Texinfo node names to HTML names is applied;
+see this entire section for details (@pxref{HTML Xref}).  The unusual
address@hidden@@@@@address@hidden separator is used because it is not a valid 
Texinfo
+construct, so can't appear in the node names.
+
+The effect is that @command{makeinfo} generates a redirect from
address@hidden to @var{new-node-name} when producing HTML output.
+Thus, external links to the old node will not simply break.
+
+Lines consisting only of whitespace are ignored.  Comments are
+indicated with a @samp{@@c} at the beginning of a line, optionally
+preceded by whitespace.
+
+
 @node Command List
 @appendix @@-Command List
 @cindex Alphabetical @@-command list
@@ -20269,7 +20331,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.258 2010/07/18 23:01:02 pertusus Exp $
+$Id: texinfo.txi,v 1.259 2010/07/19 18:28:10 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}
@@ -20348,7 +20410,7 @@
 
 @verbatim
 \input texinfo   @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.258 2010/07/18 23:01:02 pertusus Exp $
address@hidden $Id: texinfo.txi,v 1.259 2010/07/19 18:28:10 karl Exp $
 @comment %**start of header
 @setfilename sample.info
 @include version.texi

Index: texi2html/ChangeLog
===================================================================
RCS file: /sources/texinfo/texinfo/texi2html/ChangeLog,v
retrieving revision 1.526
retrieving revision 1.527
diff -u -b -r1.526 -r1.527
--- texi2html/ChangeLog 18 Jul 2010 23:06:37 -0000      1.526
+++ texi2html/ChangeLog 19 Jul 2010 18:28:10 -0000      1.527
@@ -1,3 +1,8 @@
+2010-07-19  Karl Berry  <address@hidden>
+
+       * texi2html.pl (collect_renamed_nodes): comments begin with @c\b,
+       not just @c.
+
 2010-07-19  Patrice Dumas  <address@hidden>
 
        * texi2html.pl: do redirection files for renamed nodes, using 

Index: texi2html/texi2html.pl
===================================================================
RCS file: /sources/texinfo/texinfo/texi2html/texi2html.pl,v
retrieving revision 1.405
retrieving revision 1.406
diff -u -b -r1.405 -r1.406
--- texi2html/texi2html.pl      18 Jul 2010 23:06:37 -0000      1.405
+++ texi2html/texi2html.pl      19 Jul 2010 18:28:10 -0000      1.406
@@ -90,7 +90,7 @@
 }
 
 # CVS version:
-# $Id: texi2html.pl,v 1.405 2010/07/18 23:06:37 pertusus Exp $
+# $Id: texi2html.pl,v 1.406 2010/07/19 18:28:10 karl Exp $
 
 # Homepage:
 my $T2H_HOMEPAGE = "http://www.gnu.org/software/texinfo/";;
@@ -16798,7 +16798,7 @@
           {
               $renamd_nodes_line_nr++;
               next unless (/\S/);
-              next if (/address@hidden/);
+              next if (/address@hidden/);
               if (s/address@hidden@\{\}\s+(\S)/$1/)
               {
                  chomp;