summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrian Gaeke <gaeke@uiuc.edu>2003-08-19 22:56:22 +0000
committerBrian Gaeke <gaeke@uiuc.edu>2003-08-19 22:56:22 +0000
commit9d292ff37e1f92dc30aad905158ec940f036ec18 (patch)
treebbb8130429b9d240a3cb15649226c41f1d89f650
parent9042eaf803eee86628b3a7040d672d2266363880 (diff)
downloadllvm-9d292ff37e1f92dc30aad905158ec940f036ec18.tar.gz
llvm-9d292ff37e1f92dc30aad905158ec940f036ec18.tar.bz2
llvm-9d292ff37e1f92dc30aad905158ec940f036ec18.tar.xz
Add warning about how you have to put cl::init after cl::location, if both
appear for the same option. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@7977 91177308-0d34-0410-b5e6-96231b3b80d8
-rw-r--r--docs/CommandLine.html7
1 files changed, 6 insertions, 1 deletions
diff --git a/docs/CommandLine.html b/docs/CommandLine.html
index abc6eb6823..8cc2dc8b58 100644
--- a/docs/CommandLine.html
+++ b/docs/CommandLine.html
@@ -919,7 +919,12 @@ example.<p>
<li><a name="cl::init">The <b><tt>cl::init</tt></b> attribute specifies an
inital value for a <a href="#cl::opt">scalar</a> option. If this attribute is
not specified then the command line option value defaults to the value created
-by the default constructor for the type.<p>
+by the default constructor for the type. <b>Warning</b>: If you specify both
+<b><tt>cl::init</tt></b> and <b><tt>cl::location</tt></b> for an option,
+you must specify <b><tt>cl::location</tt></b> first, so that when the
+command-line parser sees <b><tt>cl::init</tt></b>, it knows where to put the
+initial value. (You will get an error at runtime if you don't put them in
+the right order.)<p>
<li><a name="cl::location">The <b><tt>cl::location</tt></b> attribute where to
store the value for a parsed command line option if using external storage. See