diff --git a/docs/TestingLibcxx.rst b/docs/TestingLibcxx.rst index 15605ab8f..9226ae170 100644 --- a/docs/TestingLibcxx.rst +++ b/docs/TestingLibcxx.rst @@ -98,7 +98,7 @@ configuration. Passing the option on the command line will override the default. .. program:: lit -.. option:: cxx_under_test=path/to/compiler +.. option:: --cxx_under_test= Specify the compiler used to build the tests. @@ -108,24 +108,24 @@ configuration. Passing the option on the command line will override the default. Change the standard version used when building the tests. -.. option:: libcxx_site_config=path/to/lit.site.cfg +.. option:: --libcxx_site_config= Specify the site configuration to use when running the tests. This option overrides the enviroment variable LIBCXX_SITE_CONFIG. -.. option:: libcxx_headers=path/to/headers +.. option:: --libcxx_headers= Specify the libc++ headers that are tested. By default the headers in the source tree are used. -.. option:: cxx_library_root=path/to/lib/ +.. option:: --cxx_library_root= Specify the directory of the libc++ library to be tested. By default the library folder of the build directory is used. This option cannot be used when use_system_lib is provided. -.. option:: cxx_runtime_root=path/to/lib/ +.. option:: --cxx_runtime_root= Specify the directory of the libc++ library to use at runtime. This directory is not added to the linkers search path. This can be used to compile tests @@ -133,21 +133,21 @@ configuration. Passing the option on the command line will override the default. for this option is `cxx_library_root`. This option cannot be used when use_system_lib is provided. -.. option:: use_system_lib= +.. option:: --use_system_lib= **Default**: False Enable or disable testing against the installed version of libc++ library. Note: This does not use the installed headers. -.. option:: use_lit_shell= +.. option:: --use_lit_shell= Enable or disable the use of LIT's internal shell in ShTests. If the environment variable LIT_USE_INTERNAL_SHELL is present then that is used as the default value. Otherwise the default value is True on Windows and False on every other platform. -.. option:: no_default_flags= +.. option:: --no_default_flags= **Default**: False @@ -155,16 +155,16 @@ configuration. Passing the option on the command line will override the default. option is used only flags specified using the compile_flags and link_flags will be used. -.. option:: compile_flags="list-of-args" +.. option:: --compile_flags="" Specify additional compile flags as a space delimited string. Note: This options should not be used to change the standard version used. -.. option:: link_flags="list-of-args" +.. option:: --link_flags="" Specify additional link flags as a space delimited string. -.. option:: debug_level= +.. option:: --debug_level= **Values**: 0, 1 @@ -188,7 +188,7 @@ configuration. Passing the option on the command line will override the default. Environment Variables --------------------- -.. envvar:: LIBCXX_SITE_CONFIG=path/to/lit.site.cfg +.. envvar:: LIBCXX_SITE_CONFIG= Specify the site configuration to use when running the tests. Also see :option:`libcxx_site_config`.