| 1 | <html> |
|---|
| 2 | |
|---|
| 3 | <head> |
|---|
| 4 | <meta http-equiv="Content-Language" content="en-us"> |
|---|
| 5 | <meta name="GENERATOR" content="Microsoft FrontPage 5.0"> |
|---|
| 6 | <meta name="ProgId" content="FrontPage.Editor.Document"> |
|---|
| 7 | <meta http-equiv="Content-Type" content="text/html; charset=windows-1252"> |
|---|
| 8 | <title>Inspect Tool</title> |
|---|
| 9 | </head> |
|---|
| 10 | |
|---|
| 11 | <body bgcolor="#FFFFFF"> |
|---|
| 12 | |
|---|
| 13 | <h1> |
|---|
| 14 | <img src="../../boost.png" alt="boost.png (6897 bytes)" align="center" width="277" height="86">Inspect |
|---|
| 15 | Tool</h1> |
|---|
| 16 | <p>It is not uncommon for various common errors or |
|---|
| 17 | <a href="../../more/lib_guide.htm">guideline violations</a> to creep into the |
|---|
| 18 | Boost libraries. The <i>inspect</i> program detects and reports several common |
|---|
| 19 | problems. It can be used to scan a proposed Boost submission to identify various |
|---|
| 20 | failures.</p> |
|---|
| 21 | <p>The <i>inspect</i> program is written in C++ to limit tool chain |
|---|
| 22 | dependencies, and should be portable to any system.</p> |
|---|
| 23 | <p>The program is run in the directory to be scanned for errors. Sub-directories |
|---|
| 24 | are also included in the scan.</p> |
|---|
| 25 | <p>If the first program argument is <code>-cvs</code>, only files and |
|---|
| 26 | directories in the CVS tree of the current directory are scanned. Otherwise all |
|---|
| 27 | files and sub-directories are included in the scan.</p> |
|---|
| 28 | <p>If the first program argument is <code>-help</code>, a usage message is |
|---|
| 29 | displayed, showing all available program options.</p> |
|---|
| 30 | <p>The program sources include:</p> |
|---|
| 31 | <ul> |
|---|
| 32 | <li><a href="inspector.hpp">inspect.hpp</a> and <a href="inspect.cpp"> |
|---|
| 33 | inspect.cpp</a></li> |
|---|
| 34 | <li><a href="link_check.hpp">link_check.hpp</a> and <a href="link_check.cpp"> |
|---|
| 35 | link_check.cpp</a></li> |
|---|
| 36 | <li><a href="long_name_check.hpp">long_name_check.hpp</a> and |
|---|
| 37 | <a href="long_name_check.cpp">long_name_check.cpp</a></li> |
|---|
| 38 | <li><a href="tab_check.hpp">tab_check.hpp</a> and <a href="tab_check.cpp"> |
|---|
| 39 | tab_check.cpp</a></li> |
|---|
| 40 | </ul> |
|---|
| 41 | <p>A <a href="build/Jamfile.v2">Jamfile</a> is provided to build the program.</p> |
|---|
| 42 | <hr> |
|---|
| 43 | <p>Revised |
|---|
| 44 | <!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->29 December, 2003<!--webbot bot="Timestamp" endspan i-checksum="38523" --></p> |
|---|
| 45 | |
|---|
| 46 | <p>© Copyright Beman Dawes, 2003</p> |
|---|
| 47 | <p> Distributed under the Boost Software |
|---|
| 48 | License, Version 1.0. (See accompanying file <a href="../../LICENSE_1_0.txt"> |
|---|
| 49 | LICENSE_1_0.txt</a> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt"> |
|---|
| 50 | www.boost.org/LICENSE_1_0.txt</a>)</p> |
|---|
| 51 | |
|---|
| 52 | </body> |
|---|
| 53 | |
|---|
| 54 | </html> |
|---|
