summaryrefslogtreecommitdiffstats
path: root/llvm/docs/CommandLine.html
diff options
context:
space:
mode:
authorReid Spencer <rspencer@reidspencer.com>2004-11-16 06:11:52 +0000
committerReid Spencer <rspencer@reidspencer.com>2004-11-16 06:11:52 +0000
commit5e5547045ba347e8c4e7b327ebd402ab6b0e3497 (patch)
tree54d8716fbd0f9171fe303872c3b437470c3d0b99 /llvm/docs/CommandLine.html
parentf242979cd0b57a0ba03f069f649b8a653c12ebdc (diff)
downloadbcm5719-llvm-5e5547045ba347e8c4e7b327ebd402ab6b0e3497.tar.gz
bcm5719-llvm-5e5547045ba347e8c4e7b327ebd402ab6b0e3497.zip
Per code review:
*Implement/Document the cl::extrahelp feature instead of the MoreHelp ptr. llvm-svn: 17871
Diffstat (limited to 'llvm/docs/CommandLine.html')
-rw-r--r--llvm/docs/CommandLine.html30
1 files changed, 30 insertions, 0 deletions
diff --git a/llvm/docs/CommandLine.html b/llvm/docs/CommandLine.html
index 531c0f899c9..c5fa4d36f1e 100644
--- a/llvm/docs/CommandLine.html
+++ b/llvm/docs/CommandLine.html
@@ -2,6 +2,7 @@
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>CommandLine 2.0 Library Manual</title>
<link rel="stylesheet" href="llvm.css" type="text/css">
</head>
@@ -61,6 +62,7 @@
<li><a href="#cl::opt">The <tt>cl::opt</tt> class</a></li>
<li><a href="#cl::list">The <tt>cl::list</tt> class</a></li>
<li><a href="#cl::alias">The <tt>cl::alias</tt> class</a></li>
+ <li><a href="#cl::extrahelp">The <tt>cl::extrahelp</tt> class</a></li>
</ul></li>
<li><a href="#builtinparsers">Builtin parsers</a>
@@ -1519,6 +1521,34 @@ the conversion from string to data.</p>
</div>
+<!-- _______________________________________________________________________ -->
+<div class="doc_subsubsection">
+ <a name="cl::extrahelp">The <tt>cl::extrahelp</tt> class</a>
+</div>
+
+<div class="doc_text">
+
+<p>The <tt>cl::extrahelp</tt> class is a nontemplated class that allows extra
+help text to be printed out for the <tt>--help</tt> option.</p>
+
+<pre>
+<b>namespace</b> cl {
+ <b>struct</b> extrahelp;
+}
+</pre>
+
+<p>To use the extrahelp, simply construct one with a <tt>const char*</tt>
+parameter to the constructor. The text passed to the constructor will be printed
+at the bottom of the help message, verbatim. Note that multiple
+<tt>cl::extrahelp</tt> <b>can</b> be used but this practice is discouraged. If
+your tool needs to print additional help information, put all that help into a
+single <tt>cl::extrahelp</tt> instance.</p>
+<p>For example:</p>
+<pre>
+ cl::extrahelp("\nADDITIONAL HELP:\n\n This is the extra help\n");
+</pre>
+</div>
+
<!-- ======================================================================= -->
<div class="doc_subsection">
<a name="builtinparsers">Builtin parsers</a>
OpenPOWER on IntegriCloud