JezK
Edit File: Using-Info_002dvalidate.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <!-- Created by GNU Texinfo 6.8, https://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <!-- This manual is for GNU Texinfo (version 6.8, 8 June 2021), a documentation system that can produce both online information and a printed manual from a single source using semantic markup. Copyright (C) 1988, 1990-1993, 1995-1999, 2001-2021 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 no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License". --> <title>Using Info-validate (GNU Texinfo 6.8)</title> <meta name="description" content="Using Info-validate (GNU Texinfo 6.8)"> <meta name="keywords" content="Using Info-validate (GNU Texinfo 6.8)"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="texi2any"> <meta name="viewport" content="width=device-width,initial-scale=1"> <link href="index.html" rel="start" title="Top"> <link href="Command-and-Variable-Index.html" rel="index" title="Command and Variable Index"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="Running-Info_002dvalidate.html" rel="up" title="Running Info-validate"> <link href="Unsplit.html" rel="next" title="Unsplit"> <style type="text/css"> <!-- a.copiable-anchor {visibility: hidden; text-decoration: none; line-height: 0em} a.summary-letter {text-decoration: none} blockquote.indentedblock {margin-right: 0em} div.display {margin-left: 3.2em} div.example {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} span.nolinebreak {white-space: nowrap} span.roman {font-family: initial; font-weight: normal} span.sansserif {font-family: sans-serif; font-weight: normal} span:hover a.copiable-anchor {visibility: visible} ul.no-bullet {list-style: none} --> </style> </head> <body lang="en"> <div class="subsection" id="Using-Info_002dvalidate"> <div class="header"> <p> Next: <a href="Unsplit.html" accesskey="n" rel="next">Creating an Unsplit File</a>, Up: <a href="Running-Info_002dvalidate.html" accesskey="u" rel="up">Finding Badly Referenced Nodes</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p> </div> <hr> <span id="Using-Info_002dvalidate-1"></span><h4 class="subsubsection">D.9.6.1 Using <code>Info-validate</code></h4> <span id="index-Using-Info_002dvalidate"></span> <span id="index-Info-validating-a-large-file"></span> <span id="index-Validating-a-large-file"></span> <p>To use <code>Info-validate</code>, visit the Info file you wish to check and type: </p> <div class="example"> <pre class="example">M-x Info-validate </pre></div> <p>Note that the <code>Info-validate</code> command requires an uppercase ‘I’. You may also need to create a tag table before running <code>Info-validate</code>. See <a href="Tagifying.html">Tagifying a File</a>. </p> <p>If your file is valid, you will receive a message that says “File appears valid”. However, if you have a pointer that does not point to a node, error messages will be displayed in a buffer called ‘<samp>*problems in info file*</samp>’. </p> <p>For example, <code>Info-validate</code> was run on a test file that contained only the first node of this manual. One of the messages said: </p> <div class="example"> <pre class="example">In node "Overview", invalid Next: Texinfo Mode </pre></div> <p>This meant that the node called ‘<samp>Overview</samp>’ had a ‘Next’ pointer that did not point to anything (which was true in this case, since the test file had only one node in it). </p> <p>Now suppose we add a node named ‘<samp>Texinfo Mode</samp>’ to our test case but we do not specify a ‘Previous’ for this node. Then we will get the following error message: </p> <div class="example"> <pre class="example">In node "Texinfo Mode", should have Previous: Overview </pre></div> <p>This is because every ‘Next’ pointer should be matched by a ‘Previous’ (in the node where the ‘Next’ points) which points back. </p> <p><code>Info-validate</code> also checks that all menu entries and cross-references point to actual nodes. </p> <p><code>Info-validate</code> requires a tag table and does not work with files that have been split. (The <code>texinfo-format-buffer</code> command automatically splits large files.) In order to use <code>Info-validate</code> on a large file, you must run <code>texinfo-format-buffer</code> with an argument so that it does not split the Info file; and you must create a tag table for the unsplit file. </p> </div> <hr> <div class="header"> <p> Next: <a href="Unsplit.html">Creating an Unsplit File</a>, Up: <a href="Running-Info_002dvalidate.html">Finding Badly Referenced Nodes</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p> </div> </body> </html>