X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=docs%2FCommandGuide%2Flit.rst;h=0ec14bb2236eacb8c7b78165252238787514a75a;hb=0805780408c97128dc9164d4dbb8604882f5588e;hp=5e986c85fed5c04c267048cfe495d748ec7c52f1;hpb=59c6b1073c48befe021de024a693bed94147120c;p=oota-llvm.git diff --git a/docs/CommandGuide/lit.rst b/docs/CommandGuide/lit.rst index 5e986c85fed..0ec14bb2236 100644 --- a/docs/CommandGuide/lit.rst +++ b/docs/CommandGuide/lit.rst @@ -56,7 +56,7 @@ GENERAL OPTIONS Search for :file:`{NAME}.cfg` and :file:`{NAME}.site.cfg` when searching for test suites, instead of :file:`lit.cfg` and :file:`lit.site.cfg`. -.. option:: --param NAME, --param NAME=VALUE +.. option:: -D NAME, -D NAME=VALUE, --param NAME, --param NAME=VALUE Add a user defined parameter ``NAME`` with the given ``VALUE`` (or the empty string if not given). The meaning and use of these parameters is test suite @@ -80,10 +80,23 @@ OUTPUT OPTIONS Show more information on test failures, for example the entire test output instead of just the test result. +.. option:: -a, --show-all + + Show more information about all tests, for example the entire test + commandline and output. + .. option:: --no-progress-bar Do not use curses based progress bar. +.. option:: --show-unsupported + + Show the names of unsupported tests. + +.. option:: --show-xfail + + Show the names of tests that were expected to fail. + .. _execution-options: EXECUTION OPTIONS @@ -149,7 +162,11 @@ ADDITIONAL OPTIONS .. option:: --show-suites - List the discovered test suites as part of the standard output. + List the discovered test suites and exit. + +.. option:: --show-tests + + List all of the discovered tests and exit. EXIT STATUS ----------- @@ -258,7 +275,7 @@ Once a test suite is discovered, its config file is loaded. Config files themselves are Python modules which will be executed. When the config file is executed, two important global variables are predefined: -**lit** +**lit_config** The global **lit** configuration object (a *LitConfig* instance), which defines the builtin test formats, global configuration parameters, and other helper @@ -303,14 +320,6 @@ executed, two important global variables are predefined: **root** The root configuration. This is the top-most :program:`lit` configuration in the project. - **on_clone** The config is actually cloned for every subdirectory inside a test - suite, to allow local configuration on a per-directory basis. The *on_clone* - variable can be set to a Python function which will be called whenever a - configuration is cloned (for a subdirectory). The function should takes three - arguments: (1) the parent configuration, (2) the new configuration (which the - *on_clone* function will generally modify), and (3) the test path to the new - directory being scanned. - **pipefail** Normally a test using a shell pipe fails if any of the commands on the pipe fail. If this is not desired, setting this variable to false makes the test fail only if the last command in the pipe fails. @@ -337,7 +346,7 @@ LOCAL CONFIGURATION FILES ~~~~~~~~~~~~~~~~~~~~~~~~~ When :program:`lit` loads a subdirectory in a test suite, it instantiates a -local test configuration by cloning the configuration for the parent direction +local test configuration by cloning the configuration for the parent directory --- the root of this configuration chain will always be a test suite. Once the test configuration is cloned :program:`lit` checks for a *lit.local.cfg* file in the subdirectory. If present, this file will be loaded and can be used to