bug-texinfo
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Invalid Info references


From: Juri Linkov
Subject: Invalid Info references
Date: Wed, 18 Dec 2003 05:01:07 +0200
User-agent: Gnus/5.1003 (Gnus v5.10.3) Emacs/21.3.50 (gnu/linux)

I noticed that Texinfo manual has a broken reference to an Info manual.
Then I run the `info-xref-check' command which reported 10 bad references:

In file texinfo/doc/texinfo:
Not available to check: (diffutils)
No such node: (info-stnd)info standalone
No such node: (dvips)dvips invocation
No such node: (info)Expert
No such node: (info)Help-Adv
Not available to check: (info-file-name)
Not available to check: (weather)
Not available to check: (INFO-FILE-NAME)
No such node: (info)Expert
No such node: (make)Top): 1
No such node: (dvips)dvips invocation
No such node: (emacs)Edit Options
No such node: (emacs)Edit Options
No such node: (emacs)Command Switches
Not available to check: (automake)
done, 37 good, 10 bad

I took the task to find correct references, and here I submit a patch
that fixes them.  Some comments:

fixed references:
- renamed diffutils to diff because currently it is named diff.info
  in its latest version;
- edit-option is now an obsolete package, so I removed it in one place
  and replaced with customize in another place;
- "(make)Top):" has a redundant closing parentheses to help Info
  reader to find the end of reference, but it still fails in the
  Emacs Info reader, so I replaced ")" with "," which works in both
  Emacs and standalone reader;
- I also fixed one reference in the info-stnd.texi file (see below)

not fixed references:
- (weather), (info-file-name), (INFO-FILE-NAME) are examples, so it's OK;
- automake installed on Debian has two different info files:
  automake-1.4.info and automake-1.7.info, and neither of them can be
  referenced by the "(automake)Top".  I don't know how to fix it.

===================================================================
diff -c texinfo/doc/texinfo.txi~ texinfo/doc/texinfo.txi
*** texinfo/doc/texinfo.txi~    Wed Dec 18 01:45:05 2003
--- texinfo/doc/texinfo.txi     Wed Dec 18 04:28:32 2003
***************
*** 762,768 ****
  
  @cindex Patches, contributing
  Patches are most welcome; if possible, please make them with
! @address@hidden -c}} (@pxref{Top,, Overview, diffutils, Comparing and
  Merging Files}) and include @file{ChangeLog} entries (@pxref{Change
  Log,,, emacs, The GNU Emacs Manual}).
  
--- 762,768 ----
  
  @cindex Patches, contributing
  Patches are most welcome; if possible, please make them with
! @address@hidden -c}} (@pxref{Top,, Overview, diff, Comparing and
  Merging Files}) and include @file{ChangeLog} entries (@pxref{Change
  Log,,, emacs, The GNU Emacs Manual}).
  
***************
*** 826,834 ****
  information for menus, cross-references, indices, and so on.  See the
  next section (@pxref{Info Files}) for more details on this format.
  The Emacs Info subsystem (@pxref{Top,,Getting Started,info, Info}),
! and the standalone @command{info} program (@pxref{info
! standalone,,,info-stnd, GNU Info}), among others, can read these
! files.  @xref{Creating and Installing Info Files}.
  
  @item Plain text
  @cindex Plain text output
--- 826,834 ----
  information for menus, cross-references, indices, and so on.  See the
  next section (@pxref{Info Files}) for more details on this format.
  The Emacs Info subsystem (@pxref{Top,,Getting Started,info, Info}),
! and the standalone @command{info} program (@pxref{Top,,Info
! Standalone, info-stnd, GNU Info}), among others, can read these files.
! @xref{Creating and Installing Info Files}.
  
  @item Plain text
  @cindex Plain text output
***************
*** 859,867 ****
  format is output by the @TeX{} typesetting program
  (@uref{http://tug.org}).  This is then read by a DVI `driver', which
  writes the actual device-specific commands that can be viewed or
! printed, notably Dvips for translation to PostScript (@pxref{dvips
! invocation,,, dvips, Dvips}) and Xdvi for viewing on an X display
! (@uref{http://sourceforge.net/projects/xdvi/}).  @xref{Hardcopy}.
  
  Be aware that the Texinfo language is very different from and much
  stricter than @TeX{}'s usual languages, plain @TeX{} and @LaTeX{}.
--- 859,868 ----
  format is output by the @TeX{} typesetting program
  (@uref{http://tug.org}).  This is then read by a DVI `driver', which
  writes the actual device-specific commands that can be viewed or
! printed, notably Dvips for translation to PostScript (@pxref{Invoking
! Dvips,,Dvips Invocation, dvips, Dvips}) and Xdvi for viewing on an X
! display (@uref{http://sourceforge.net/projects/xdvi/}).
! @xref{Hardcopy}.
  
  Be aware that the Texinfo language is very different from and much
  stricter than @TeX{}'s usual languages, plain @TeX{} and @LaTeX{}.
***************
*** 1008,1014 ****
  
  If you want to read through an Info file in sequence, as if it were a
  printed manual, you can hit @key{SPC} repeatedly, or you get the whole
! file with the advanced Info command @kbd{g *}.  (@inforef{Expert,
  Advanced Info commands, info}.)@refill
  
  @c !!! dir file may be located in one of many places:
--- 1009,1015 ----
  
  If you want to read through an Info file in sequence, as if it were a
  printed manual, you can hit @key{SPC} repeatedly, or you get the whole
! file with the advanced Info command @kbd{g *}.  (@inforef{Advanced,
  Advanced Info commands, info}.)@refill
  
  @c !!! dir file may be located in one of many places:
***************
*** 5556,5563 ****
  reference names that address@hidden
  
  In Info, a cross reference results in an entry that you can follow using
! the Info @samp{f} command.  (@inforef{Help-Adv, Some advanced Info
! commands, info}.)@refill
  
  The various cross reference commands use nodes (or anchors,
  @pxref{anchor,,@code{@@anchor}}) to define cross reference locations.
--- 5557,5564 ----
  reference names that address@hidden
  
  In Info, a cross reference results in an entry that you can follow using
! the Info @samp{f} command.  (@inforef{Help-Xref, Following
! cross-references, info}.)@refill
  
  The various cross reference commands use nodes (or anchors,
  @pxref{anchor,,@code{@@anchor}}) to define cross reference locations.
***************
*** 6389,6395 ****
  
  @example
  @group
! @@address@hidden, Advanced Info commands, address@hidden,
  for more information.
  @end group
  @end example
--- 6390,6396 ----
  
  @example
  @group
! @@address@hidden, Advanced Info commands, address@hidden,
  for more information.
  @end group
  @end example
***************
*** 6400,6406 ****
  
  @example
  @group
! *Note Advanced Info commands: (info)Expert,
  for more information.
  @end group
  @end example
--- 6401,6407 ----
  
  @example
  @group
! *Note Advanced Info commands: (info)Advanced,
  for more information.
  @end group
  @end example
***************
*** 6410,6416 ****
  and
  
  @quotation
! See Info file @file{info}, node @samp{Expert}, for more information.
  @end quotation
  
  @need 800
--- 6411,6417 ----
  and
  
  @quotation
! See Info file @file{info}, node @samp{Advanced}, for more information.
  @end quotation
  
  @need 800
***************
*** 6419,6425 ****
  
  @example
  @group
! @@address@hidden, , address@hidden, for more information.
  @end group
  @end example
  
--- 6420,6426 ----
  
  @example
  @group
! @@address@hidden, , address@hidden, for more information.
  @end group
  @end example
  
***************
*** 6428,6434 ****
  produces
  
  @example
! *Note (info)Expert::, for more information.
  @end example
  
  @need 800
--- 6429,6435 ----
  produces
  
  @example
! *Note (info)Advanced::, for more information.
  @end example
  
  @need 800
***************
*** 6436,6442 ****
  and
  
  @quotation
! See Info file @file{info}, node @samp{Expert}, for more information.
  @end quotation
  
  The converse of @code{@@inforef} is @code{@@cite}, which is used to
--- 6437,6443 ----
  and
  
  @quotation
! See Info file @file{info}, node @samp{Advanced}, for more information.
  @end quotation
  
  The converse of @code{@@inforef} is @code{@@cite}, which is used to
***************
*** 10416,10423 ****
  @code{texinfo-footnote-style} variable controls the footnote style.
  It can be either @samp{"separate"} for the separate node style or
  @samp{"end"} for the end of node style.  (You can change the value of
! this variable with the @kbd{M-x edit-options} command (@pxref{Edit
! Options, , Editing Variable Values, emacs, The GNU Emacs Manual}), or
  with the @kbd{M-x set-variable} command (@pxref{Examining, , Examining
  and Setting Variables, emacs, The GNU Emacs Manual}).
  
--- 10417,10424 ----
  @code{texinfo-footnote-style} variable controls the footnote style.
  It can be either @samp{"separate"} for the separate node style or
  @samp{"end"} for the end of node style.  (You can change the value of
! this variable with the @kbd{M-x customize} command (@pxref{Easy
! Customization, , Easy Customization Interface, emacs, The GNU Emacs Manual}), 
or
  with the @kbd{M-x set-variable} command (@pxref{Examining, , Examining
  and Setting Variables, emacs, The GNU Emacs Manual}).
  
***************
*** 12592,12598 ****
  to work with Automake distributions.
  
  Here is an example adapted from @ref{Top,, Overview, make, The GNU Make
! Manual}):
  
  @enumerate
  @item
--- 12593,12599 ----
  to work with Automake distributions.
  
  Here is an example adapted from @ref{Top,, Overview, make, The GNU Make
! Manual},:
  
  @enumerate
  @item
***************
*** 13743,13749 ****
  @end example
  
  @item Convert the DVI file to a Postscript or PCL file and send it to your
! local printer.  @xref{dvips invocation,,, dvips, Dvips}, and the man
  pages for @code{dvilj}, for detailed description of these tools.  Once
  the DVI file is converted to the format your local printer understands
  directly, just send it to the appropriate port, usually @samp{PRN}.
--- 13744,13750 ----
  @end example
  
  @item Convert the DVI file to a Postscript or PCL file and send it to your
! local printer.  @xref{Invoking Dvips,,Dvips Invocation, dvips, Dvips}, and 
the man
  pages for @code{dvilj}, for detailed description of these tools.  Once
  the DVI file is converted to the format your local printer understands
  directly, just send it to the appropriate port, usually @samp{PRN}.
***************
*** 13883,13893 ****
  @end example
  
  You can change the values of these variables with the @kbd{M-x
! edit-options} command (@pxref{Edit Options, , Editing Variable Values,
! emacs, The GNU Emacs Manual}), with the @kbd{M-x set-variable} command
! (@pxref{Examining, , Examining and Setting Variables, emacs, The GNU
! Emacs Manual}), or with your @file{.emacs} initialization file
! (@pxref{Init File, , , emacs, The GNU Emacs Manual})address@hidden
  
  @cindex Customize Emacs package (@t{Development/Docs/Texinfo})
  Beginning with version 20, GNU Emacs offers a user-friendly interface,
--- 13884,13893 ----
  @end example
  
  You can change the values of these variables with the @kbd{M-x
! set-variable} command (@pxref{Examining, , Examining and Setting
! Variables, emacs, The GNU Emacs Manual}), or with your @file{.emacs}
! initialization file (@pxref{Init File, , , emacs, The GNU Emacs
! Manual})address@hidden
  
  @cindex Customize Emacs package (@t{Development/Docs/Texinfo})
  Beginning with version 20, GNU Emacs offers a user-friendly interface,
***************
*** 14913,14919 ****
  
  You can specify options for @code{makeinfo} by setting the
  @code{makeinfo-options} variable with either the @kbd{M-x
! edit-options} or the @kbd{M-x set-variable} command, or by setting the
  variable in your @file{.emacs} initialization address@hidden
  
  For example, you could write the following in your @file{.emacs} file:@refill
--- 14913,14919 ----
  
  You can specify options for @code{makeinfo} by setting the
  @code{makeinfo-options} variable with either the @kbd{M-x
! customize} or the @kbd{M-x set-variable} command, or by setting the
  variable in your @file{.emacs} initialization address@hidden
  
  For example, you could write the following in your @file{.emacs} file:@refill
***************
*** 14931,14943 ****
  @c three references to the same named manual, which looks strange.
  @iftex
  For more information, see @ref{makeinfo options, , Options for
! @code{makeinfo}}, as well as ``Editing Variable Values,'' ``Examining
  and Setting Variables,'' and ``Init File'' in @cite{The GNU Emacs
  Manual}.
  @end iftex
  @ifnottex
  For more information, address@hidden
! @ref{Edit Options, , Editing Variable Values, emacs, The GNU Emacs Manual},@*
  @ref{Examining, , Examining and Setting Variables, emacs, The GNU Emacs 
Manual},@*
  @ref{Init File, , , emacs, The GNU Emacs Manual}, address@hidden
  @ref{makeinfo options, , Options for @code{makeinfo}}.
--- 14931,14943 ----
  @c three references to the same named manual, which looks strange.
  @iftex
  For more information, see @ref{makeinfo options, , Options for
! @code{makeinfo}}, as well as ``Easy Customization Interface,'' ``Examining
  and Setting Variables,'' and ``Init File'' in @cite{The GNU Emacs
  Manual}.
  @end iftex
  @ifnottex
  For more information, address@hidden
! @ref{Easy Customization, , Easy Customization Interface, emacs, The GNU Emacs 
Manual},@*
  @ref{Examining, , Examining and Setting Variables, emacs, The GNU Emacs 
Manual},@*
  @ref{Init File, , , emacs, The GNU Emacs Manual}, address@hidden
  @ref{makeinfo options, , Options for @code{makeinfo}}.
***************
*** 14987,14994 ****
  
  You can format Texinfo files for Info using @code{batch-texinfo-format}
  and Emacs Batch mode.  You can run Emacs in Batch mode from any shell,
! including a shell inside of Emacs.  (@xref{Command Switches, , Command
! Line Switches and Arguments, emacs, The GNU Emacs Manual}.)@refill
  
  Here is a shell command to format all the files that end in
  @file{.texinfo} in the current directory:
--- 14987,14994 ----
  
  You can format Texinfo files for Info using @code{batch-texinfo-format}
  and Emacs Batch mode.  You can run Emacs in Batch mode from any shell,
! including a shell inside of Emacs.  (@xref{Command Arguments, , Command
! Line Arguments, emacs, The GNU Emacs Manual}.)@refill
  
  Here is a shell command to format all the files that end in
  @file{.texinfo} in the current directory:
===================================================================

===================================================================
diff -c texinfo/doc/info-stnd.texi~ texinfo/doc/info-stnd.texi
*** texinfo/doc/info-stnd.texi~ Wed Dec 18 02:07:09 2003
--- texinfo/doc/info-stnd.texi  Wed Dec 18 02:35:57 2003
***************
*** 342,349 ****
  Emacs and standalone versions) have several commands which allow you to
  move the cursor about the screen.  The notation used in this manual to
  describe keystrokes is identical to the notation used within the Emacs
! manual, and the GNU Readline manual.  @xref{Characters, , Character
! Conventions, emacs, the GNU Emacs Manual}, if you are unfamiliar with the
  address@hidden
  Here's a short summary.  @address@hidden means press the @kbd{CTRL} key
  and the key @var{x}.  @address@hidden means press the @kbd{META} key and
--- 342,349 ----
  Emacs and standalone versions) have several commands which allow you to
  move the cursor about the screen.  The notation used in this manual to
  describe keystrokes is identical to the notation used within the Emacs
! manual, and the GNU Readline manual.  @xref{User Input, , Kinds of
! User Input, emacs, the GNU Emacs Manual}, if you are unfamiliar with the
  address@hidden
  Here's a short summary.  @address@hidden means press the @kbd{CTRL} key
  and the key @var{x}.  @address@hidden means press the @kbd{META} key and
===================================================================

-- 
http://www.jurta.org/emacs/





reply via email to

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