From aa3d6242cfb3a21922f7ec13cbd5b65303a51f80 Mon Sep 17 00:00:00 2001 From: NAKAMURA Takumi Date: Sat, 23 Apr 2011 00:30:22 +0000 Subject: docs: Introduce cascading style
and

continued on .

Section Example

Section preamble.

Subsection Example

Subsection body

FIXME: Care H5 better. llvm-svn: 130040 --- llvm/docs/TestingGuide.html | 74 +++++++++++++++++++++++++-------------------- 1 file changed, 42 insertions(+), 32 deletions(-) (limited to 'llvm/docs/TestingGuide.html') diff --git a/llvm/docs/TestingGuide.html b/llvm/docs/TestingGuide.html index 3d6aa92ffb1..12b29c9b36d 100644 --- a/llvm/docs/TestingGuide.html +++ b/llvm/docs/TestingGuide.html @@ -55,7 +55,7 @@

Overview

-
+

This document is the reference manual for the LLVM testing infrastructure. It documents the structure of the LLVM testing infrastructure, the tools needed to @@ -67,7 +67,7 @@ use it, and how to add and run tests.

Requirements

-
+

In order to use the LLVM testing infrastructure, you will need all of the software required to build LLVM, as well @@ -79,7 +79,7 @@ as Python 2.4 or later.

LLVM testing infrastructure organization

-
+

The LLVM testing infrastructure contains two major categories of tests: regression tests and whole programs. The regression tests are contained inside @@ -89,13 +89,11 @@ referred to as the "LLVM test suite" and are in the test-suite module in subversion.

-
-

Regression tests

-
+

The regression tests are small pieces of code that test a specific feature of LLVM or trigger a specific bug in LLVM. They are usually written in LLVM @@ -122,7 +120,7 @@ application or benchmark.

Test suite

-
+

The test suite contains whole programs, which are pieces of code which can be compiled and linked into a stand-alone program that can be @@ -147,7 +145,7 @@ generates code.

Debugging Information tests

-
+

The test suite contains tests to check quality of debugging information. The test are written in C based languages or in LLVM assembly language.

@@ -159,11 +157,13 @@ test suite for more information . This test suite is located in the
+
+

Quick start

-
+

The tests are located in two separate Subversion modules. The regressions tests are in the main "llvm" module under the directory @@ -179,6 +179,7 @@ Alternatively, you can configure the test-suite module manually.

Regression tests

+

To run all of the LLVM regression tests, use master Makefile in the llvm/test directory:

@@ -238,10 +239,14 @@ script which is built as part of LLVM. For example, to run the

For more information on using the 'lit' tool, see 'llvm-lit --help' or the 'lit' man page.

+
+

Test suite

+
+

To run the comprehensive test suite (tests that compile and execute whole programs), first checkout and setup the test-suite module:

@@ -292,8 +297,9 @@ that subdirectory.

Debugging Information tests

+
-
+

To run debugging information tests simply checkout the tests inside clang/test directory.

@@ -309,10 +315,14 @@ clang/test directory.

+
+ +
+

Regression test structure

-
+

The LLVM regression tests are driven by 'lit' and are located in the llvm/test directory. @@ -334,12 +344,10 @@ clang/test directory.

  • Verifier: tests the IR verifier.
    • -
    -

    Writing new regression tests

    -
    +

    The regression test structure is very simple, but does require some information to be set. This information is gathered via configure and is written to a file, lit.site.cfg @@ -494,7 +502,7 @@ negatives).

    The FileCheck utility

    -
    +

    A powerful feature of the RUN: lines is that it allows any arbitrary commands to be executed as part of the test harness. While standard (portable) unix @@ -560,14 +568,12 @@ is a "subl" in between those labels. If it existed somewhere else in the file, that would not count: "grep subl" matches if subl exists anywhere in the file.

    -
    -

    The FileCheck -check-prefix option

    -
    +

    The FileCheck -check-prefix option allows multiple test configurations to be driven from one .ll file. This is useful in many circumstances, for example, @@ -602,7 +608,7 @@ both 32-bit and 64-bit code generation.

    The "CHECK-NEXT:" directive -
    +

    Sometimes you want to match lines and would like to verify that matches happen on exactly consecutive lines with no other lines in between them. In @@ -643,7 +649,7 @@ directive in a file.

    The "CHECK-NOT:" directive -
    +

    The CHECK-NOT: directive is used to verify that a string doesn't occur between two matches (or the first match and the beginning of the file). For @@ -674,7 +680,7 @@ define i8 @coerce_offset0(i32 %V, i32* %P) { FileCheck Pattern Matching Syntax -

    +

    The CHECK: and CHECK-NOT: directives both take a pattern to match. For most uses of FileCheck, fixed string matching is perfectly sufficient. For some @@ -707,7 +713,7 @@ braces explicitly from the input, you can use something ugly like FileCheck Variables -

    +

    It is often useful to match a pattern and then verify that it occurs again later in the file. For codegen tests, this can be useful to allow any register, @@ -742,10 +748,12 @@ define two separate CHECK lines that match on the same line.

    +
    +

    Variables and substitutions

    -
    +

    With a RUN line there are a number of substitutions that are permitted. In general, any Tcl variable that is available in the substitute function (in test/lib/llvm.exp) can be substituted into a RUN line. @@ -840,7 +848,7 @@ define two separate CHECK lines that match on the same line.

    Other Features

    -
    +

    To make RUN line writing easier, there are several shell scripts located in the llvm/test/Scripts directory. This directory is in the PATH when running tests, so you can just call these scripts using their name. For @@ -895,11 +903,13 @@ define two separate CHECK lines that match on the same line.

    +
    +

    Test suite Structure

    -
    +

    The test-suite module contains a number of programs that can be compiled with LLVM and executed. These programs are compiled using the native compiler @@ -967,7 +977,7 @@ will help you separate benign warnings from actual test failures.

    Running the test suite

    -
    +

    First, all tests are executed within the LLVM object directory tree. They are not executed inside of the LLVM source tree. This is because the @@ -1022,15 +1032,13 @@ test suite creates temporary files during execution.

    have the suite checked out and configured, you don't need to do it again (unless the test code or configure script changes).

    -
    -

    Configuring External Tests

    -
    +

    In order to run the External tests in the test-suite module, you must specify --with-externals. This must be done during the re-configuration step (see above), @@ -1062,7 +1070,7 @@ the test code or configure script changes).

    Running different tests -
    +

    In addition to the regular "whole program" tests, the test-suite module also provides a mechanism for compiling the programs in different ways. If the variable TEST is defined on the gmake command line, the test system will @@ -1086,7 +1094,7 @@ LLVM.

    Generating test output -
    +

    There are a number of ways to run the tests and generate output. The most simple one is simply running gmake with no arguments. This will compile and run all programs in the tree using a number of different methods @@ -1119,7 +1127,7 @@ LLVM.

    -
    +

    Assuming you can run the test suite, (e.g. "gmake TEST=nightly report" should work), it is really easy to run optimizations or code generator @@ -1185,6 +1193,8 @@ example reports that can do fancy stuff.

    +
    +
    -- cgit v1.2.3