Boost C++ Libraries

libs/test/doc/runtime_configuration/runtime_config_summary.qbk

[/
 / Copyright (c) 2013 Boost.Test contributors
 /
 / Distributed under the Boost Software License, Version 1.0. (See accompanying
 / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 /]

[section:summary Summary of run-time parameters]

[table
  [
    [Command]
    [Short description]
  ]

  [/ ###############################################################################################]
  [
    [[link boost_test.utf_reference.rt_param_reference.auto_dbg `auto_start_dbg`]]
    [Instructs the framework to automatically attach debugger in case of system failure.]
  ]

  [/ ###############################################################################################]
  [
    [[link boost_test.utf_reference.rt_param_reference.build_info `build_info`]]
    [Instructs the framework to display library build information.]
  ]

  [/ ###############################################################################################]
  [
    [[link boost_test.utf_reference.rt_param_reference.catch_system `catch_system_error`]]
    [Instructs the framework to catch system errors.]
  ]

  [/ ###############################################################################################]
  [
    [[link boost_test.utf_reference.rt_param_reference.color_output `color_output`]]
    [Instructs the framework to produce color output]
  ]

  [/ ###############################################################################################]
  [
    [[link boost_test.utf_reference.rt_param_reference.detect_fp_exceptions `detect_fp_exceptions`]]
    [Instructs the framework to trap floating point exceptions (on supported platforms).]
  ]

  [/ ###############################################################################################]
  [
    [[link boost_test.utf_reference.rt_param_reference.detect_memory_leaks `detect_memory_leaks`]]
    [Instructs the framework to detect memory leaks (on supported platforms).]
  ]

  [/ ###############################################################################################]
  [
    [[link boost_test.utf_reference.rt_param_reference.help `help`]]
    [Provides help on the __UTF__ parameters.]
  ]

  [/ ###############################################################################################]
  [
    [[link boost_test.utf_reference.rt_param_reference.list_content `list_content`]]
    [Lists the tests units, their organization in the test tree, their enabled/disabled state...]
  ]

  [/ ###############################################################################################]
  [
    [[link boost_test.utf_reference.rt_param_reference.list_labels `list_labels`]]
    [Lists the labels defined in the test module.]
  ]

  [/ ###############################################################################################]
  [
    [[link boost_test.utf_reference.rt_param_reference.log_format `log_format`]]
    [Specifies the log format]
  ]

  [/ ###############################################################################################]
  [
    [[link boost_test.utf_reference.rt_param_reference.log_level `log_level`]]
    [Specifies the framework's logging level]
  ]

  [/ ###############################################################################################]
  [
    [[link boost_test.utf_reference.rt_param_reference.log_sink `log_sink`]]
    [Specifies where to write testing log to.]
  ]

  [/ ###############################################################################################]
  [
    [[link boost_test.utf_reference.rt_param_reference.logger `logger`]]
    [Specifies the log level, format and sink of one or more loggers.]
  ]

  [/ ###############################################################################################]
  [
    [[link boost_test.utf_reference.rt_param_reference.output_format `output_format`]]
    [Specifies the log format and the report format.]
  ]

  [/ ###############################################################################################]
  [
    [[link boost_test.utf_reference.rt_param_reference.random `random`]]
    [Instructs the framework to run the tests in random order]
  ]

  [/ ###############################################################################################]
  [
    [[link boost_test.utf_reference.rt_param_reference.report_format `report_format`]]
    [Specifies the report format.]
  ]

  [/ ###############################################################################################]
  [
    [[link boost_test.utf_reference.rt_param_reference.report_level `report_level`]]
    [Specifies the level of details carried by the framework's testing result report.]
  ]

  [/ ###############################################################################################]
  [
    [[link boost_test.utf_reference.rt_param_reference.report_memory_leaks_to `report_memory_leaks_to`]]
    [Specifies file name where memory leaks report should be re-directed to.]
  ]

  [/ ###############################################################################################]
  [
    [[link boost_test.utf_reference.rt_param_reference.report_sink `report_sink`]]
    [Specifies where to write the testing result report to.]
  ]

  [/ ###############################################################################################]
  [
    [[link boost_test.utf_reference.rt_param_reference.result_code `result_code`]]
    [Instructs the framework to return or ignore a result code indicating an error in the tests.]
  ]

  [/ ###############################################################################################]
  [
    [__param_run_test__]
    [Allows to filter which test units to execute at runtime.]
  ]

  [/ ###############################################################################################]
  [
    [[link boost_test.utf_reference.rt_param_reference.save_pattern `save_pattern`]]
    [Facilitates mode switching for testing output streams.]
  ]

  [/ ###############################################################################################]
  [
    [[link boost_test.utf_reference.rt_param_reference.show_progress `show_progress`]]
    [Instructs the framework to print progress information. More details [link boost_test.test_output.test_output_progress here].]
  ]

  [/ ###############################################################################################]
  [
    [[link boost_test.utf_reference.rt_param_reference.use_alt_stack `use_alt_stack`]]
    [Instructs the framework to use an alternative stack for signal processing (on supported platforms).]
  ]

  [/ ###############################################################################################]
  [
    [[link boost_test.utf_reference.rt_param_reference.usage `usage`]]
    [Displays short usage message.]
  ]

  [/ ###############################################################################################]
  [
    [[link boost_test.utf_reference.rt_param_reference.wait_for_debugger `wait_for_debugger`]]
    [Instructs the framework to pause test module before testing is started to allow debugger to attach.]
  ]
]

[endsect]