[llvm-commits] CVS: llvm/docs/CommandLine.html

[Reid Spencer]

Changes in directory llvm/docs:

CommandLine.html updated: 1.40 -> 1.41
---
Log message:

Document the cl::SetVersionPrinter function.


---
Diffs of the changes:  (+24 -1)

 CommandLine.html |   25 ++++++++++++++++++++++++-
 1 files changed, 24 insertions(+), 1 deletion(-)


Index: llvm/docs/CommandLine.html
diff -u llvm/docs/CommandLine.html:1.40 llvm/docs/CommandLine.html:1.41
--- llvm/docs/CommandLine.html:1.40	Mon Mar 13 23:39:39 2006
+++ llvm/docs/CommandLine.html	Mon Jun  5 12:30:16 2006
@@ -60,6 +60,8 @@
             <tt>cl::ParseCommandLineOptions</tt> function</a></li>
         <li><a href="#cl::ParseEnvironmentOptions">The 
             <tt>cl::ParseEnvironmentOptions</tt> function</a></li>
+        <li><a href="#cl::SetVersionPrinter">The cl::SetVersionPrinter
+          function</a></li>
         <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::bits">The <tt>cl::bits</tt> class</a></li>
@@ -1507,6 +1509,27 @@
 
 <!-- _______________________________________________________________________ -->
 <div class="doc_subsubsection">
+  <a name="cl::SetVersionPrinter">The <tt>cl::SetVersionPrinter</tt>
+  function</a>
+</div>
+
+<div class="doc_text">
+
+<p>The <tt>cl::SetVersionPrinter</tt> function is designed to be called
+directly from <tt>main</tt>, and <i>before</i>
+<tt>cl::ParseCommandLineOptions</tt>. Its use is optional. It simply arranges
+for a function to be called in response to the <tt>--version</tt> option instead
+of having the <tt>CommandLine</tt> library print out the usual version string
+for LLVM. This is useful for programs that are not part of LLVM but wish to use
+the <tt>CommandLine</tt> facilities. Such programs should just define a small
+function that takes no arguments and returns <tt>void</tt> and that prints out
+whatever version information is appropriate for the program. Pass the address
+of that function to <tt>cl::SetVersionPrinter</tt> to arrange for it to be
+called when the <tt>--version</tt> option is given by the user.</p>
+
+</div>
+<!-- _______________________________________________________________________ -->
+<div class="doc_subsubsection">
   <a name="cl::opt">The <tt>cl::opt</tt> class</a>
 </div>
 
@@ -1900,7 +1923,7 @@
 
   <a href="mailto:sabre at nondot.org">Chris Lattner</a><br>
   <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
-  Last modified: $Date: 2006/03/14 05:39:39 $
+  Last modified: $Date: 2006/06/05 17:30:16 $
 </address>
 
 </body>