/usr/share/doc/texinfo/html/Pointer-Validation.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is for GNU Texinfo (version 5.2, 26 September 2013),
a documentation system that can produce both online information and a
printed manual from a single source using semantic markup.

Copyright (C) 1988, 1990, 1991, 1992, 1993, 1995, 1996, 1997,
1998, 1999, 2001, 2001, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
2010, 2011, 2012, 2013 Free Software Foundation, Inc.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with the Front-Cover Texts being "A GNU Manual",
and with the Back-Cover Texts as in (a) below.  A copy of the license
is included in the section entitled "GNU Free Documentation
License".

(a) The FSF's Back-Cover Text is: "You have the freedom to copy and
modify this GNU manual.  Buying copies from the FSF supports it in
developing GNU and promoting software freedom." -->
<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Texinfo 5.2: Pointer Validation</title>

<meta name="description" content="GNU Texinfo 5.2: Pointer Validation">
<meta name="keywords" content="GNU Texinfo 5.2: Pointer Validation">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Command-and-Variable-Index.html#Command-and-Variable-Index" rel="index" title="Command and Variable Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Generic-Translator-texi2any.html#Generic-Translator-texi2any" rel="up" title="Generic Translator texi2any">
<link href="Customization-Variables.html#Customization-Variables" rel="next" title="Customization Variables">
<link href="texi2any-Printed-Output.html#texi2any-Printed-Output" rel="previous" title="texi2any Printed Output">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Pointer-Validation"></a>
<div class="header">
<p>
Next: <a href="Customization-Variables.html#Customization-Variables" accesskey="n" rel="next">Customization Variables</a>, Previous: <a href="texi2any-Printed-Output.html#texi2any-Printed-Output" accesskey="p" rel="previous"><tt>texi2any</tt> Printed Output</a>, Up: <a href="Generic-Translator-texi2any.html#Generic-Translator-texi2any" accesskey="u" rel="up">Generic Translator <tt>texi2any</tt></a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html#Command-and-Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Pointer-Validation-1"></a>
<h3 class="section">22.4 Pointer Validation</h3>
<a name="index-Pointer-validation-with-makeinfo"></a>
<a name="index-Validation-of-pointers"></a>

<p>If you do not suppress pointer validation with the
&lsquo;<samp>--no-validate</samp>&rsquo; option or the <code>@novalidate</code> command in the
source file (see <a href="Use-TeX.html#Use-TeX">Use TeX</a>), <code>makeinfo</code> will check the
validity of the Texinfo file.
</p>
<p>Most validation checks are different depending on whether node
pointers are explicitly or implicitly determined.  With explicit node
pointers, here is the list of what is checked:
</p>
<ol>
<li> If a &lsquo;Next&rsquo;, &lsquo;Previous&rsquo;, or &lsquo;Up&rsquo; node reference is a reference to a
node in the current file and is not an external reference such as to
<samp>(dir)</samp>, then the referenced node must exist.

</li><li> Every node except the &lsquo;Top&rsquo; node must have an &lsquo;Up&rsquo; pointer.

</li><li> The node referenced by an &lsquo;Up&rsquo; pointer must itself reference the
current node through a menu item, unless the node referenced by &lsquo;Up&rsquo;
has the form &lsquo;<samp>(<var>file</var>)</samp>&rsquo;.
</li></ol>

<p>With implicit node pointers, the above error cannot occur, as such.
(Which is a major reason why we recommend using this feature of
<code>makeinfo</code>, and not specifying any node pointers yourself.)
</p>
<p>Instead, <code>makeinfo</code> checks that the tree constructed from the
document&rsquo;s menus matches the tree constructed from the sectioning
commands.  For example, if a chapter-level menu mentions nodes
<var>n1</var> and <var>n2</var>, in that order, nodes <var>n1</var> and <var>n2</var> must
be associated with <code>@section</code> commands in the chapter.
</p>
<p>Finally, with both explicit and implicit node pointers,
<code>makeinfo</code> checks that every node except the &lsquo;Top&rsquo; node is
referenced in a menu.
</p>




</body>
</html>
texinfo-doc-nonfree 5.2.0-1 / usr / share / doc / texinfo / html / Pointer-Validation.html
