CbC/CbC_llvm: docs/TestingGuide.rst comparison

comparison docs/TestingGuide.rst @ 77:54457678186b LLVM3.6

LLVM 3.6

author	Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
date	Mon, 08 Sep 2014 22:06:00 +0900
parents	95c75e76d11b
children	60c9769439b8

comparison

equal deleted inserted replaced

-:e874dbf0ad9d
+:54457678186b
 For instance, on ``test/CodeGen/ARM``, the ``lit.local.cfg`` is:
 .. code-block:: python
 config.suffixes = ['.ll', '.c', '.cpp', '.test']
-targets = set(config.root.targets_to_build.split())
+if not 'ARM' in config.root.targets:
-if not 'ARM' in targets:
 config.unsupported = True
 Other platform-specific tests are those that depend on a specific feature
 of a specific sub-architecture, for example only to Intel chips that support ``AVX2``.
 depends on special features of sub-architectures, you must add the specific
 triple, test with the specific FileCheck and put it into the specific
 directory that will filter out all other architectures.
-Variables and substitutions
+Substitutions
----------------------------
+-------------
-With a RUN line there are a number of substitutions that are permitted.
+Besides replacing LLVM tool names the following substitutions are performed in
-To make a substitution just write the variable's name preceded by a ``$``.
+RUN lines:
-Additionally, for compatibility reasons with previous versions of the
-test library, certain names can be accessed with an alternate syntax: a
+``%%``
-% prefix. These alternates are deprecated and may go away in a future
+Replaced by a single ``%``. This allows escaping other substitutions.
-version.
+``%s``
-Here are the available variable names. The alternate syntax is listed in
+File path to the test case's source. This is suitable for passing on the
-parentheses.
+command line as the input to an LLVM tool.
-``$test`` (``%s``)
+Example: ``/home/user/llvm/test/MC/ELF/foo_test.s``
-The full path to the test case's source. This is suitable for passing on
-the command line as the input to an LLVM tool.
+``%S``
+Directory path to the test case's source.
-``%(line)``, ``%(line+<number>)``, ``%(line-<number>)``
-The number of the line where this variable is used, with an optional
+Example: ``/home/user/llvm/test/MC/ELF``
-integer offset. This can be used in tests with multiple RUN lines,
-which reference test file's line numbers.
+``%t``
+File path to a temporary file name that could be used for this test case.
-``$srcdir``
-The source directory from where the ``make check`` was run.
-``objdir``
-The object directory that corresponds to the ``$srcdir``.
-``subdir``
-A partial path from the ``test`` directory that contains the
-sub-directory that contains the test source being executed.
-``srcroot``
-The root directory of the LLVM src tree.
-``objroot``
-The root directory of the LLVM object tree. This could be the same as
-the srcroot.
-``path``
-The path to the directory that contains the test case source. This is
-for locating any supporting files that are not generated by the test,
-but used by the test.
-``tmp``
-The path to a temporary file name that could be used for this test case.
 The file name won't conflict with other test cases. You can append to it
 if you need multiple temporaries. This is useful as the destination of
 some redirected output.
-``target_triplet`` (``%target_triplet``)
+Example: ``/home/user/llvm.build/test/MC/ELF/Output/foo_test.s.tmp``
-The target triplet that corresponds to the current host machine (the one
-running the test cases). This should probably be called "host".
+``%T``
+Directory of ``%t``.
-``link`` (``%link``)
-This full link command used to link LLVM executables. This has all the
+Example: ``/home/user/llvm.build/test/MC/ELF/Output``
-configured ``-I``, ``-L`` and ``-l`` options.
+``%{pathsep}``
-``shlibext`` (``%shlibext``)
-The suffix for the host platforms shared library (DLL) files. This
+Expands to the path separator, i.e. ``:`` (or ``;`` on Windows).
-includes the period as the first character.
-To add more variables, look at ``test/lit.cfg``.
+**LLVM-specific substitutions:**
+``%shlibext``
+The suffix for the host platforms shared library files. This includes the
+period as the first character.
+Example: ``.so`` (Linux), ``.dylib`` (OS X), ``.dll`` (Windows)
+``%exeext``
+The suffix for the host platforms executable files. This includes the
+period as the first character.
+Example: ``.exe`` (Windows), empty on Linux.
+``%(line)``, ``%(line+<number>)``, ``%(line-<number>)``
+The number of the line where this substitution is used, with an optional
+integer offset. This can be used in tests with multiple RUN lines, which
+reference test file's line numbers.
+**Clang-specific substitutions:**
+``%clang``
+Invokes the Clang driver.
+``%clang_cpp``
+Invokes the Clang driver for C++.
+``%clang_cl``
+Invokes the CL-compatible Clang driver.
+``%clangxx``
+Invokes the G++-compatible Clang driver.
+``%clang_cc1``
+Invokes the Clang frontend.
+``%itanium_abi_triple``, ``%ms_abi_triple``
+These substitutions can be used to get the current target triple adjusted to
+the desired ABI. For example, if the test suite is running with the
+``i686-pc-win32`` target, ``%itanium_abi_triple`` will expand to
+``i686-pc-mingw32``. This allows a test to run with a specific ABI without
+constraining it to a specific triple.
+To add more substituations, look at ``test/lit.cfg`` or ``lit.local.cfg``.
 Other Features
 --------------
-To make RUN line writing easier, there are several helper scripts and programs
+To make RUN line writing easier, there are several helper programs. These
-in the ``llvm/test/Scripts`` directory. This directory is in the PATH
+helpers are in the PATH when running tests, so you can just call them using
-when running tests, so you can just call these scripts using their name.
+their name. For example:
-For example:
-``ignore``
-This script runs its arguments and then always returns 0. This is useful
-in cases where the test needs to cause a tool to generate an error (e.g.
-to check the error output). However, any program in a pipeline that
-returns a non-zero result will cause the test to fail.  This script
-overcomes that issue and nicely documents that the test case is
-purposefully ignoring the result code of the tool
 ``not``
-This script runs its arguments and then inverts the result code from it.
+This program runs its arguments and then inverts the result code from it.
 Zero result codes become 1. Non-zero result codes become 0.
 Sometimes it is necessary to mark a test case as "expected fail" or
 XFAIL. You can easily mark a test as XFAIL just by including ``XFAIL:``
 on a line near the top of the file. This signals that the test case

Mercurial > hg > CbC > CbC_llvm

comparison docs/TestingGuide.rst @ 77:54457678186b LLVM3.6