ceph/src/boost/libs/test/doc/runtime_configuration/runtime_configuration.qbk

   1 [/
   2  / Copyright (c) 2003 Boost.Test contributors
   3  /
   4  / Distributed under the Boost Software License, Version 1.0. (See accompanying
   5  / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
   6  /]
   7
   8
   9 [section:runtime_config Runtime parameters]
  10
  11
  12 The __UTF__ supports multiple parameters that affect test module execution. To set the parameter's value you can
  13 either use a runtime configuration subsystem interface from within the test module initialization function or you can
  14 specify the value at runtime during test module invocation.
  15
  16 The __UTF__ provides two ways to set a parameter at runtime: by specifying a command line argument and by setting an
  17 environment variable. The command line argument always overrides the corresponding environment variable.
  18
  19 During test module initialization the __UTF__ parses the command line and excludes all parameters that belong to it and
  20 their values from the argument list. The rest of command line is forwarded to the test module initialization function
  21 supplied by you. The command line argument format expected by the __UTF__ is:
  22
  23 [pre
  24   --<command_line_argument_name>=<argument_value>
  25 ]
  26
  27 The command line argument name is case sensitive. It is required to match exactly the name in parameter specification.
  28 There should not be any spaces between '=' and either command line argument name or argument value.
  29
  30
  31 The corresponding environment variable name is also case sensitive and is required to exactly match the name in the
  32 parameter specification.
  33
  34 All information about supported parameters is summarized below in the reference section.
  35
  36 [include test_unit_filtering.qbk]
  37 [include runtime_config_summary.qbk]
  38
  39
  40 [endsect] [/ runtime configuration]