changeset 16772:7eff3032d144

Fix seealso HTML links when using Texinfo 4.X (bug #38862). Use the prefix 'docX' instead of 'doc-' for Texinfo references. * doc/interpreter/arith.txi, doc/interpreter/basics.txi, doc/interpreter/container.txi, doc/interpreter/func.txi, doc/interpreter/java.txi, doc/interpreter/matrix.txi, doc/interpreter/munge-texi.pl, doc/interpreter/package.txi, doc/interpreter/plot.txi, doc/interpreter/stats.txi, doc/interpreter/strings.txi, doc/interpreter/system.txi, doc/interpreter/var.txi, doc/interpreter/vectorize.txi, libinterp/corefcn/qz.cc, libinterp/corefcn/regexp.cc, libinterp/interpfcn/error.cc, scripts/general/accumarray.m, scripts/general/structfun.m, scripts/miscellaneous/setfield.m, scripts/optimization/fminbnd.m, scripts/optimization/fzero.m, scripts/optimization/lsqnonneg.m: Use the prefix 'docX' instead of 'doc-' for Texinfo references.
author Rik <rik@octave.org>
date Tue, 18 Jun 2013 20:35:12 -0700
parents d8a719ccd464
children 3542e106c496
files doc/interpreter/arith.txi doc/interpreter/basics.txi doc/interpreter/container.txi doc/interpreter/func.txi doc/interpreter/java.txi doc/interpreter/matrix.txi doc/interpreter/munge-texi.pl doc/interpreter/package.txi doc/interpreter/plot.txi doc/interpreter/stats.txi doc/interpreter/strings.txi doc/interpreter/system.txi doc/interpreter/var.txi doc/interpreter/vectorize.txi libinterp/corefcn/qz.cc libinterp/corefcn/regexp.cc libinterp/interpfcn/error.cc scripts/general/accumarray.m scripts/general/structfun.m scripts/miscellaneous/setfield.m scripts/optimization/fminbnd.m scripts/optimization/fzero.m scripts/optimization/lsqnonneg.m
diffstat 23 files changed, 49 insertions(+), 49 deletions(-) [+]
line wrap: on
line diff
--- a/doc/interpreter/arith.txi	Tue Jun 18 17:58:00 2013 -0700
+++ b/doc/interpreter/arith.txi	Tue Jun 18 20:35:12 2013 -0700
@@ -311,7 +311,7 @@
 
 @DOCSTRING(legendre)
 
-@anchor{doc-gammaln}
+@anchor{docXgammaln}
 @DOCSTRING(lgamma)
 
 @node Rational Approximations
--- a/doc/interpreter/basics.txi	Tue Jun 18 17:58:00 2013 -0700
+++ b/doc/interpreter/basics.txi	Tue Jun 18 20:35:12 2013 -0700
@@ -75,8 +75,8 @@
 parser to print a lot of information about the commands it reads, and is
 probably only useful if you are actually trying to debug the parser.
 
-@item --doc-cache-file @var{filename}
-@cindex @code{--doc-cache-file @var{filename}}
+@item --docXcache-file @var{filename}
+@cindex @code{--docXcache-file @var{filename}}
 Specify the name of the doc cache file to use.  The value of @var{filename}
 specified on the command line will override any value of
 @w{@env{OCTAVE_DOC_CACHE_FILE}} found in the environment, but not any commands
@@ -264,8 +264,8 @@
 @noindent
 Note that this does not enable the @code{Octave:matlab-incompatible}
 warning, which you might want if you want to be told about writing code
-that works in Octave but not Matlab (@pxref{doc-warning},
-@pxref{doc-warning_ids}).
+that works in Octave but not Matlab (@pxref{docXwarning},
+@pxref{docXwarning_ids}).
 
 @item  --verbose
 @itemx -V
--- a/doc/interpreter/container.txi	Tue Jun 18 17:58:00 2013 -0700
+++ b/doc/interpreter/container.txi	Tue Jun 18 20:35:12 2013 -0700
@@ -410,7 +410,7 @@
 
 @noindent
 The warning id @code{Octave:matlab-incompatible} can be enabled to warn
-about this usage. @xref{doc-warning_ids}.
+about this usage. @xref{docXwarning_ids}.
 
 More realistically, all of the functions that operate on strings can be used
 to build the correct field name before it is entered into the data structure.
@@ -529,7 +529,7 @@
 The simplest way to process data in a structure is within a @code{for}
 loop (@pxref{Looping Over Structure Elements}).  A similar effect can be
 achieved with the @code{structfun} function, where a user defined
-function is applied to each field of the structure.  @xref{doc-structfun}.
+function is applied to each field of the structure.  @xref{docXstructfun}.
 
 Alternatively, to process the data in a structure, the structure might
 be converted to another type of container before being treated.
@@ -683,10 +683,10 @@
 @end example
 
 @noindent
-As can be seen, the @ref{doc-size, @code{size}} function also works
+As can be seen, the @ref{docXsize, @code{size}} function also works
 for cell arrays.  As do other functions describing the size of an
-object, such as @ref{doc-length, @code{length}}, @ref{doc-numel,
-@code{numel}}, @ref{doc-rows, @code{rows}}, and @ref{doc-columns,
+object, such as @ref{docXlength, @code{length}}, @ref{docXnumel,
+@code{numel}}, @ref{docXrows, @code{rows}}, and @ref{docXcolumns,
 @code{columns}}.
 
 @DOCSTRING(cell)
@@ -907,7 +907,7 @@
 is to iterate through it using one or more @code{for} loops.  The same
 idea can be implemented more easily through the use of the @code{cellfun}
 function that calls a user-specified function on all elements of a cell
-array.  @xref{doc-cellfun}.
+array.  @xref{docXcellfun}.
 
 An alternative is to convert the data to a different container, such as
 a matrix or a data structure.  Depending on the data this is possible
--- a/doc/interpreter/func.txi	Tue Jun 18 17:58:00 2013 -0700
+++ b/doc/interpreter/func.txi	Tue Jun 18 20:35:12 2013 -0700
@@ -402,7 +402,7 @@
 
 @DOCSTRING(nargoutchk)
 
-@anchor{doc-varargin} @anchor{doc-varargout}
+@anchor{docXvarargin} @anchor{docXvarargout}
 @node Variable-length Argument Lists
 @section Variable-length Argument Lists
 @cindex variable-length argument lists
@@ -1150,7 +1150,7 @@
 A function that has been defined on the command-line.
 
 @item Autoload function
-A function that is marked as autoloaded with @xref{doc-autoload}.
+A function that is marked as autoloaded with @xref{docXautoload}.
 
 @item A Function on the Path
 A function that can be found on the users load-path.  There can also be
--- a/doc/interpreter/java.txi	Tue Jun 18 17:58:00 2013 -0700
+++ b/doc/interpreter/java.txi	Tue Jun 18 20:35:12 2013 -0700
@@ -151,7 +151,7 @@
 @c ------------------------------------------------------------------------
 @node How to distinguish between Octave and Matlab?
 @subsection How to distinguish between Octave and Matlab?
-@anchor{doc-FAQ}
+@anchor{docXFAQ}
 @c - index -
 @cindex Octave and @sc{matlab}, how to distinguish between
 @c - index -
@@ -316,7 +316,7 @@
 In order to execute Java code Octave creates a Java Virtual Machine (JVM).
 Such a JVM allocates a fixed amount of initial memory and may expand this pool
 up to a fixed maximum memory limit.  The default values depend on the Java
-version (see @ref{doc-javamem,,javamem}).  The memory pool is shared by all
+version (see @ref{docXjavamem,,javamem}).  The memory pool is shared by all
 Java objects running in the JVM@.  This strict memory limit is intended mainly
 to avoid that runaway applications inside web browsers or in enterprise servers
 can consume all memory and crash the system.  When the maximum memory limit is
--- a/doc/interpreter/matrix.txi	Tue Jun 18 17:58:00 2013 -0700
+++ b/doc/interpreter/matrix.txi	Tue Jun 18 20:35:12 2013 -0700
@@ -124,7 +124,7 @@
 
 @DOCSTRING(nth_element)
 
-@anchor{doc-triu}
+@anchor{docXtriu}
 @DOCSTRING(tril)
 
 @DOCSTRING(vec)
--- a/doc/interpreter/munge-texi.pl	Tue Jun 18 17:58:00 2013 -0700
+++ b/doc/interpreter/munge-texi.pl	Tue Jun 18 20:35:12 2013 -0700
@@ -61,7 +61,7 @@
     }
 
     $func =~ s/^@/@@/;   # Texinfo uses @@ to produce '@'
-    $docstring =~ s/^$tex_delim$/\@anchor{doc-$func}/m;
+    $docstring =~ s/^$tex_delim$/\@anchor{docX$func}/m;
     print $docstring,"\n";
 
     next TXI_LINE;
@@ -110,7 +110,7 @@
       foreach $func (split (/,/, $func_list))
       {
         $func =~ s/^@/@@/;   # Texinfo uses @@ to produce '@'
-        $repl .= "\@ref{doc-$func,,$func}, ";
+        $repl .= "\@ref{docX$func,,$func}, ";
       }
       substr($repl,-2) = "";   # Remove last ', ' 
       $_ = "\@seealso{$repl}$rest_of_line";
--- a/doc/interpreter/package.txi	Tue Jun 18 17:58:00 2013 -0700
+++ b/doc/interpreter/package.txi	Tue Jun 18 20:35:12 2013 -0700
@@ -217,7 +217,7 @@
 This is an optional file describing old entries from the @file{NEWS} file.
 
 @cindex PKG_ADD
-@anchor{doc-PKG_ADD}
+@anchor{docXPKG_ADD}
 @item package/PKG_ADD
 An optional file that includes commands that are run when the package
 is added to the users path.  Note that @w{@code{PKG_ADD}} directives in the
@@ -242,7 +242,7 @@
 directives.
 
 @cindex PKG_DEL
-@anchor{doc-PKG_DEL}
+@anchor{docXPKG_DEL}
 @item package/PKG_DEL
 An optional file that includes commands that are run when the package
 is removed from the users path.  Note that @w{@code{PKG_DEL}} directives in
--- a/doc/interpreter/plot.txi	Tue Jun 18 17:58:00 2013 -0700
+++ b/doc/interpreter/plot.txi	Tue Jun 18 20:35:12 2013 -0700
@@ -253,8 +253,8 @@
 The @code{xlim}, @code{ylim}, and @code{zlim} functions may be used to
 get or set individual axis limits.  Each has the same form.
 
-@anchor{doc-ylim}
-@anchor{doc-zlim}
+@anchor{docXylim}
+@anchor{docXzlim}
 @DOCSTRING(xlim)
 
 @node Two-dimensional Function Plotting
@@ -464,8 +464,8 @@
 
 See @ref{Text Properties} for the properties that you can set.
 
-@anchor{doc-ylabel}
-@anchor{doc-zlabel}
+@anchor{docXylabel}
+@anchor{docXzlabel}
 @DOCSTRING(xlabel)
 
 @DOCSTRING(clabel)
@@ -911,7 +911,7 @@
 @node Introduction to Graphics Structures
 @subsection Introduction to Graphics Structures
 @cindex introduction to graphics structures
-@anchor{doc-graphics structures}
+@anchor{docXgraphics structures}
 
 The graphics functions use pointers, which are of class graphics_handle, in
 order to address the data structures which control graphical displays.  A
@@ -931,7 +931,7 @@
 @code{contourf}, @code{contour3}, @code{surf}, @code{mesh}, @code{surfc},
 @code{meshc}, @code{errorbar}, @code{quiver}, @code{quiver3}, @code{scatter},
 @code{scatter3}, @code{stair}, @code{stem}, @code{stem3} each return a handle
-as documented in @ref{doc-datasources,, Data Sources}.
+as documented in @ref{docXdatasources,, Data Sources}.
 
 
 The graphics objects are arranged in a hierarchy:
@@ -1014,7 +1014,7 @@
 @code{get (0, "")}.
 
 The uses of @code{get} and @code{set} are further explained in
-@ref{doc-get,,get}, @ref{doc-set,,set}.
+@ref{docXget,,get}, @ref{docXset,,set}.
 
 @DOCSTRING(isprop)
 
@@ -2831,7 +2831,7 @@
 @node Data Sources in Object Groups
 @subsubsection Data Sources in Object Groups
 @cindex data sources in object groups
-@anchor{doc-datasources}
+@anchor{docXdatasources}
 All of the group objects contain data source parameters.  There are
 string parameters that contain an expression that is evaluated to update
 the relevant data property of the group when the @code{refreshdata}
@@ -2839,7 +2839,7 @@
 
 @DOCSTRING(refreshdata)
 
-@anchor{doc-linkdata}
+@anchor{docXlinkdata}
 @c add the description of the linkdata function here when it is written
 @c remove the explicit anchor when you add the corresponding @DOCSTRING
 @c command
--- a/doc/interpreter/stats.txi	Tue Jun 18 17:58:00 2013 -0700
+++ b/doc/interpreter/stats.txi	Tue Jun 18 20:35:12 2013 -0700
@@ -42,8 +42,8 @@
 
 It should be noted that the statistics functions don't test for data
 containing NaN, NA, or Inf.  These values need to be detected and dealt
-with explicitly.  See @ref{doc-isnan,,isnan}, @ref{doc-isna,,isna}, 
-@ref{doc-isinf,,isinf}, @ref{doc-isfinite,,isfinite}. 
+with explicitly.  See @ref{docXisnan,,isnan}, @ref{docXisna,,isna}, 
+@ref{docXisinf,,isinf}, @ref{docXisfinite,,isfinite}. 
 
 @menu
 * Descriptive Statistics::
--- a/doc/interpreter/strings.txi	Tue Jun 18 17:58:00 2013 -0700
+++ b/doc/interpreter/strings.txi	Tue Jun 18 20:35:12 2013 -0700
@@ -233,8 +233,8 @@
 (@pxref{Strings}, @ref{Character Arrays}).  Apart from that, there are several
 functions to concatenate string objects: @code{char},
 @code{strvcat}, @code{strcat} and @code{cstrcat}.  In addition, the general
-purpose concatenation functions can be used: see @ref{doc-cat,,cat},
-@ref{doc-horzcat,,horzcat} and @ref{doc-vertcat,,vertcat}.
+purpose concatenation functions can be used: see @ref{docXcat,,cat},
+@ref{docXhorzcat,,horzcat} and @ref{docXvertcat,,vertcat}.
 
 @itemize @bullet
 @item All string concatenation functions except @code{cstrcat}
@@ -351,7 +351,7 @@
 integer matrices.  @code{int2str} takes the real part of complex values and
 round fractional values to integer.  A more flexible way to format numerical
 data as strings is the @code{sprintf} function (@pxref{Formatted Output},
-@ref{doc-sprintf}).
+@ref{docXsprintf}).
 
 @DOCSTRING(mat2str)
 
--- a/doc/interpreter/system.txi	Tue Jun 18 17:58:00 2013 -0700
+++ b/doc/interpreter/system.txi	Tue Jun 18 20:35:12 2013 -0700
@@ -121,7 +121,7 @@
 
 @DOCSTRING(is_leap_year)
 
-@anchor{doc-toc}
+@anchor{docXtoc}
 @DOCSTRING(tic)
 
 @DOCSTRING(pause)
@@ -177,7 +177,7 @@
 
 @DOCSTRING(umask)
 
-@anchor{doc-lstat}
+@anchor{docXlstat}
 @DOCSTRING(stat)
 
 @DOCSTRING(S_ISBLK)
--- a/doc/interpreter/var.txi	Tue Jun 18 17:58:00 2013 -0700
+++ b/doc/interpreter/var.txi	Tue Jun 18 20:35:12 2013 -0700
@@ -178,7 +178,7 @@
 @cindex persistent variables
 @cindex @code{persistent} statement
 @cindex variables, persistent
-@anchor{doc-persistent}
+@anchor{docXpersistent}
 
 A variable that has been declared @dfn{persistent} within a function
 will retain its contents in memory between subsequent calls to the
--- a/doc/interpreter/vectorize.txi	Tue Jun 18 17:58:00 2013 -0700
+++ b/doc/interpreter/vectorize.txi	Tue Jun 18 20:35:12 2013 -0700
@@ -456,7 +456,7 @@
 that may have relied on matrices of different size producing an error.
 Due to how broadcasting changes semantics with older versions of Octave,
 by default Octave warns if a broadcasting operation is performed.  To
-disable this warning, refer to its ID (@pxref{doc-warning_ids}):
+disable this warning, refer to its ID (@pxref{docXwarning_ids}):
 
 @example
 warning ("off", "Octave:broadcast");
--- a/libinterp/corefcn/qz.cc	Tue Jun 18 17:58:00 2013 -0700
+++ b/libinterp/corefcn/qz.cc	Tue Jun 18 20:35:12 2013 -0700
@@ -367,7 +367,7 @@
 @end enumerate\n\
 \n\
 Note: @code{qz} performs permutation balancing, but not scaling\n\
-(@pxref{doc-balance}).  The order of output arguments was selected for\n\
+(@pxref{docXbalance}).  The order of output arguments was selected for\n\
 compatibility with @sc{matlab}.\n\
 @seealso{balance, eig, schur}\n\
 @end deftypefn")
--- a/libinterp/corefcn/regexp.cc	Tue Jun 18 17:58:00 2013 -0700
+++ b/libinterp/corefcn/regexp.cc	Tue Jun 18 20:35:12 2013 -0700
@@ -1067,7 +1067,7 @@
 \n\
 Case insensitive regular expression string matching.  Search for @var{pat} in\n\
 @var{str} and return the positions and substrings of any matches, or empty\n\
-values if there are none.  @xref{doc-regexp,,regexp}, for details on the\n\
+values if there are none.  @xref{docXregexp,,regexp}, for details on the\n\
 syntax of the search pattern.\n\
 @seealso{regexp}\n\
 @end deftypefn")
@@ -1279,7 +1279,7 @@
 Replace occurrences of pattern @var{pat} in @var{string} with @var{repstr}.\n\
 \n\
 The pattern is a regular expression as documented for @code{regexp}.\n\
-@xref{doc-regexp,,regexp}.\n\
+@xref{docXregexp,,regexp}.\n\
 \n\
 The replacement string may contain @code{$i}, which substitutes\n\
 for the ith set of parentheses in the match string.  For example,\n\
--- a/libinterp/interpfcn/error.cc	Tue Jun 18 17:58:00 2013 -0700
+++ b/libinterp/interpfcn/error.cc	Tue Jun 18 20:35:12 2013 -0700
@@ -1236,7 +1236,7 @@
 The optional message identifier allows users to enable or disable\n\
 warnings tagged by @var{id}.  A message identifier is of the form\n\
 \"NAMESPACE:WARNING-NAME\".  Octave's own warnings use the \"Octave\"\n\
-namespace (@pxref{doc-warning_ids}).  The special identifier @samp{\"all\"}\n\
+namespace (@pxref{docXwarning_ids}).  The special identifier @samp{\"all\"}\n\
 may be used to set the state of all warnings.\n\
 \n\
 If the first argument is @samp{\"on\"} or @samp{\"off\"}, set the state\n\
--- a/scripts/general/accumarray.m	Tue Jun 18 17:58:00 2013 -0700
+++ b/scripts/general/accumarray.m	Tue Jun 18 20:35:12 2013 -0700
@@ -61,7 +61,7 @@
 ## that in the first column counts how many occurrences each number in
 ## the second column has, taken from the vector @var{x}.  Note the usage
 ## of @code{unique}  for assigning to all repeated elements of @var{x}
-## the same index (@pxref{doc-unique}).
+## the same index (@pxref{docXunique}).
 ##
 ## @example
 ## @group
@@ -92,7 +92,7 @@
 ## @end example
 ##
 ## The sparse option can be used as an alternative to the @code{sparse}
-## constructor (@pxref{doc-sparse}).  Thus
+## constructor (@pxref{docXsparse}).  Thus
 ##
 ## @example
 ## sparse (@var{i}, @var{j}, @var{sv})
--- a/scripts/general/structfun.m	Tue Jun 18 17:58:00 2013 -0700
+++ b/scripts/general/structfun.m	Tue Jun 18 20:35:12 2013 -0700
@@ -68,7 +68,7 @@
 ## "identifier", "message" and "index", giving respectively the error
 ## identifier, the error message, and the index into the input arguments
 ## of the element that caused the error.  For an example on how to use
-## an error handler, @pxref{doc-cellfun, @code{cellfun}}.
+## an error handler, @pxref{docXcellfun, @code{cellfun}}.
 ##
 ## @seealso{cellfun, arrayfun, spfun}
 ## @end deftypefn
--- a/scripts/miscellaneous/setfield.m	Tue Jun 18 17:58:00 2013 -0700
+++ b/scripts/miscellaneous/setfield.m	Tue Jun 18 20:35:12 2013 -0700
@@ -42,7 +42,7 @@
 ## used here, as the field name is not a valid Octave identifier. Using
 ## arbitrary strings for field name is incompatible with @sc{Matlab}, so
 ## this usage will warn if the @code{Octave:matlab-incompatible} warning
-## is set. @xref{doc-warning_ids}.
+## is set. @xref{docXwarning_ids}.
 ##
 ## With the second calling form, set a field on a structure array,
 ## possibly nested, with successive nested indices @var{idx1},
--- a/scripts/optimization/fminbnd.m	Tue Jun 18 17:58:00 2013 -0700
+++ b/scripts/optimization/fminbnd.m	Tue Jun 18 20:35:12 2013 -0700
@@ -26,7 +26,7 @@
 ## starting interval.  @var{options} is a structure specifying additional
 ## options.  Currently, @code{fminbnd} recognizes these options:
 ## "FunValCheck", "OutputFcn", "TolX", "MaxIter", "MaxFunEvals".  For a
-## description of these options, see @ref{doc-optimset,,optimset}.
+## description of these options, see @ref{docXoptimset,,optimset}.
 ##
 ## On exit, the function returns @var{x}, the approximate minimum point
 ## and @var{fval}, the function value thereof.
--- a/scripts/optimization/fzero.m	Tue Jun 18 17:58:00 2013 -0700
+++ b/scripts/optimization/fzero.m	Tue Jun 18 20:35:12 2013 -0700
@@ -42,7 +42,7 @@
 ## Currently, @code{fzero}
 ## recognizes these options: @code{"FunValCheck"}, @code{"OutputFcn"},
 ## @code{"TolX"}, @code{"MaxIter"}, @code{"MaxFunEvals"}.
-## For a description of these options, see @ref{doc-optimset,,optimset}.
+## For a description of these options, see @ref{docXoptimset,,optimset}.
 ##
 ## On exit, the function returns @var{x}, the approximate zero point
 ## and @var{fval}, the function value thereof.
--- a/scripts/optimization/lsqnonneg.m	Tue Jun 18 17:58:00 2013 -0700
+++ b/scripts/optimization/lsqnonneg.m	Tue Jun 18 20:35:12 2013 -0700
@@ -32,7 +32,7 @@
 ## optional initial guess for @var{x}.
 ## Currently, @code{lsqnonneg}
 ## recognizes these options: @code{"MaxIter"}, @code{"TolX"}.
-## For a description of these options, see @ref{doc-optimset,,optimset}.
+## For a description of these options, see @ref{docXoptimset,,optimset}.
 ##
 ## Outputs:
 ##