From edf351f44e89c69921881f450d986b23e76987a9 Mon Sep 17 00:00:00 2001 From: Chris Lattner Date: Sat, 21 Jun 2003 21:45:56 +0000 Subject: [PATCH] Clarify that variables must be global git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@6835 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/CommandLine.html | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/docs/CommandLine.html b/docs/CommandLine.html index fbd1053d9cd..7c8c997a0f7 100644 --- a/docs/CommandLine.html +++ b/docs/CommandLine.html @@ -94,8 +94,9 @@ CommandLine library to have the following features:

  • Speed: The CommandLine library is very quick and uses little resources. The parsing time of the library is directly proportional to the number of arguments parsed, not the the number of options recognized. Additionally, command line -argument values are captured transparently into user defined variables, which -can be accessed like any other variable (and with the same performance).

    +argument values are captured transparently into user defined global variables, +which can be accessed like any other variable (and with the same +performance).

  • Type Safe: As a user of CommandLine, you don't have to worry about remembering the type of arguments that you want (is it an int? a string? a @@ -183,24 +184,24 @@ declarations.

    Now that you are ready to support command line arguments, we need to tell the system which ones we want, and what type of argument they are. The CommandLine -library uses a declarative syntax to model cammand line arguments with the -variable declarations that capture the parsed values. This means that for every -command line option that you would like to support, there should be a variable -declaration to capture the result. For example, in a compiler, we would like to -support the unix standard '-o <filename>' option to specify where -to put the output. With the CommandLine library, this is represented like -this:

    +library uses a declarative syntax to model command line arguments with the +global variable declarations that capture the parsed values. This means that +for every command line option that you would like to support, there should be a +global variable declaration to capture the result. For example, in a compiler, +we would like to support the unix standard '-o <filename>' option +to specify where to put the output. With the CommandLine library, this is +represented like this:

    
 cl::opt<string> OutputFilename("o", cl::desc("Specify output filename"), cl::value_desc("filename"));

    -This declares a variable "OutputFilename" that is used to capture the -result of the "o" argument (first parameter). We specify that this is -a simple scalar option by using the "cl::opt" -template (as opposed to the "cl::list -template), and tell the CommandLine library that the data type that we are -parsing is a string.

    +This declares a global variable "OutputFilename" that is used to +capture the result of the "o" argument (first parameter). We specify +that this is a simple scalar option by using the "cl::opt" template (as opposed to the "cl::list template), and tell the CommandLine library +that the data type that we are parsing is a string.

    The second and third parameters (which are optional) are used to specify what to output for the "--help" option. In this case, we get a line that looks @@ -1495,7 +1496,7 @@ line options