Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

Runtime parameters reference
PrevUpHomeNext

Following sections provide detailed specification for all Unit Test Framework runtime parameters. Each parameter specification includes:

  • The full parameter name.
  • Description of parameter semantic and default value.
  • Acceptable argument values. The default value for the parameter is bold in the acceptable values list.
  • Command line syntax. The format of all command line arguments is: <prefix><name>[<separator><value>]. For example: --param=<value>. [] around separator and value indicate that argument value is optional. For example: -q[ <value>].
  • Corresponding environment variable name.
[Note] Note

All command line argument formats support parameter name guessing. What this means is that is if command like format is like this:

--long_parameter_name=<value>

you can in fact use any unambiguous prefix of the parameter name to specify the argument. For example:

--long_param=123

or

--long_p=123.

If parameter name prefix you chose is ambiguous the framework lets you know which parameters match specified prefix. For example, try

--log=all
Parameter value formats

The Unit Test Framework runtime parameters take value of the following types: string, boolean, enumeration, unsigned, long. Formats required for values of these types are following:

String, unsigned, long

Values of these types are expected in the same format they are represented in C++.

Boolean

Values of these types are options with yes/no or true/false meaning. True values are represented by case insensitive strings: "Y", "YES", "TRUE", "1". False values are represented by case insensitive strings: "N", "NO", "FALSE", "0".

Enumeration

Values of an enumeration type are expected as case sensitive strings representing enumeration value names. Each parameter with an enumeration value lists all valid names in a parameter`s description.


PrevUpHomeNext