diff options
author | Mikhail Glushenkov <foldr@codedgers.com> | 2008-04-28 16:44:25 +0000 |
---|---|---|
committer | Mikhail Glushenkov <foldr@codedgers.com> | 2008-04-28 16:44:25 +0000 |
commit | beb4d8293d5311c4581fd3d914f865e358af53a5 (patch) | |
tree | 460cd9a49f6ee1edffbe4ff85aa863309529b798 /docs/CommandLine.html | |
parent | 2810d675f855133cad90c14d725d9ac0704f4923 (diff) | |
download | llvm-beb4d8293d5311c4581fd3d914f865e358af53a5.tar.gz llvm-beb4d8293d5311c4581fd3d914f865e358af53a5.tar.bz2 llvm-beb4d8293d5311c4581fd3d914f865e358af53a5.tar.xz |
Add support for response files to the CommandLine library.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@50355 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/CommandLine.html')
-rw-r--r-- | docs/CommandLine.html | 35 |
1 files changed, 31 insertions, 4 deletions
diff --git a/docs/CommandLine.html b/docs/CommandLine.html index 91f4b1535e..93b5ca1c69 100644 --- a/docs/CommandLine.html +++ b/docs/CommandLine.html @@ -52,6 +52,7 @@ specified</a></li> <li><a href="#formatting">Controlling other formatting options</a></li> <li><a href="#misc">Miscellaneous option modifiers</a></li> + <li><a href="#response">Response files</a></li> </ul></li> <li><a href="#toplevel">Top-Level Classes and Functions</a> @@ -1442,6 +1443,29 @@ only makes sense with a <a href="#cl::list">cl::list</a> option.</li> </div> +<!-- _______________________________________________________________________ --> +<div class="doc_subsubsection"> + <a name="response">Response files</a> +</div> + +<div class="doc_text"> + +<p>Some systems, such as certain variants of Microsoft Windows and +some older Unices have a relatively low limit on command-line +length. It is therefore customary to use the so-called 'response +files' to circumvent this restriction. These files are mentioned on +the command-line (using the "@file") syntax. The program reads these +files and inserts the contents into argv, thereby working around the +command-line length limits. Response files are enabled by an optional +fourth argument to +<a href="#cl::ParseEnvironmentOptions"><tt>cl::ParseEnvironmentOptions</tt></a> +and +<a href="#cl::ParseCommandLineOptions"><tt>cl::ParseCommandLineOptions</tt></a>. +</p> + +</div> + + <!-- ======================================================================= --> <div class="doc_subsection"> <a name="toplevel">Top-Level Classes and Functions</a> @@ -1475,7 +1499,8 @@ available.</p> <p>The <tt>cl::ParseCommandLineOptions</tt> function requires two parameters (<tt>argc</tt> and <tt>argv</tt>), but may also take an optional third parameter which holds <a href="#description">additional extra text</a> to emit when the -<tt>--help</tt> option is invoked.</p> +<tt>--help</tt> option is invoked, and a fourth boolean parameter that enables +<a href="#response">response files</a>.</p> </div> @@ -1497,11 +1522,13 @@ like <a href="#cl::ParseCommandLineOptions"><tt>cl::ParseCommandLineOptions</tt></a> does.</p> -<p>It takes three parameters: the name of the program (since <tt>argv</tt> may +<p>It takes four parameters: the name of the program (since <tt>argv</tt> may not be available, it can't just look in <tt>argv[0]</tt>), the name of the -environment variable to examine, and the optional +environment variable to examine, the optional <a href="#description">additional extra text</a> to emit when the -<tt>--help</tt> option is invoked.</p> +<tt>--help</tt> option is invoked, and the boolean +switch that controls whether <a href="#response">reponse files</a> +should be read.</p> <p><tt>cl::ParseEnvironmentOptions</tt> will break the environment variable's value up into words and then process them using |