Avoid DIDescriptor::getNode(). Use overloaded operators instead.

[oota-llvm.git] / docs / TestingGuide.html

diff --git a/docs/TestingGuide.html b/docs/TestingGuide.html
index bc19ab426267cf6f4b2979fd1b96c1a0b27c0ec4..c39065a2824eb9279ef0043ff9a549880c6dd92e 100644 (file)
--- a/docs/TestingGuide.html
+++ b/docs/TestingGuide.html
@@ -626,7 +626,7 @@ define i8 @coerce_offset0(i32 %V, i32* %P) {
 
 <!-- _______________________________________________________________________ -->
 <div class="doc_subsubsection"><a 
-name="FileCheck-Matching">FileCheck Pattern Matting Syntax</a></div>
+name="FileCheck-Matching">FileCheck Pattern Matching Syntax</a></div>
 
 <div class="doc_text">
 
@@ -656,7 +656,44 @@ braces explicitly from the input, you can use something ugly like
 
 </div>
 
+<!-- _______________________________________________________________________ -->
+<div class="doc_subsubsection"><a 
+name="FileCheck-Variables">FileCheck Variables</a></div>
+
+<div class="doc_text">
+
+<p>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,
+but verify that that register is used consistently later.  To do this, FileCheck
+allows named variables to be defined and substituted into patterns.  Here is a
+simple example:</p>
+
+<div class="doc_code">
+<pre>
+; CHECK: test5:
+; CHECK:    notw       <b>[[REGISTER:%[a-z]+]]</b>
+; CHECK:    andw       {{.*}}<b>[[REGISTER]]</b>
+</pre>
+</div>
+
+<p>The first check line matches a regex (<tt>%[a-z]+</tt>) and captures it into
+the variables "REGISTER".  The second line verifies that whatever is in REGISTER
+occurs later in the file after an "andw".  FileCheck variable references are
+always contained in <tt>[[ ]]</tt> pairs, are named, and their names can be
+formed with the regex "<tt>[a-zA-Z][a-zA-Z0-9]*</tt>".  If a colon follows the
+name, then it is a definition of the variable, if not, it is a use.</p>
+
+<p>FileCheck variables can be defined multiple times, and uses always get the
+latest value.  Note that variables are all read at the start of a "CHECK" line
+and are all defined at the end.  This means that if you have something like
+"<tt>CHECK: [[XYZ:.*]]x[[XYZ]]</tt>" that the check line will read the previous
+value of the XYZ variable and define a new one after the match is performed.  If
+you need to do something like this you can probably take advantage of the fact
+that FileCheck is not actually line-oriented when it matches, this allows you to
+define two separate CHECK lines that match on the same line.
+</p>
 
+</div>
 
 <!-- _______________________________________________________________________ -->
 <div class="doc_subsection"><a name="dgvars">Variables and
@@ -722,12 +759,6 @@ substitutions</a></div>
     <dd>The full path to the <tt>llvm-gxx</tt> executable as specified in the
     configured LLVM environment</dd>
 
-    <dt><b>llvmgcc_version</b> (%llvmgcc_version)</dt>
-    <dd>The full version number of the <tt>llvm-gcc</tt> executable.</dd>
-
-    <dt><b>llvmgccmajvers</b> (%llvmgccmajvers)</dt>
-    <dd>The major version number of the <tt>llvm-gcc</tt> executable.</dd>
-
     <dt><b>gccpath</b></dt>
     <dd>The full path to the C compiler used to <i>build </i> LLVM. Note that 
     this might not be gcc.</dd>
@@ -785,22 +816,20 @@ substitutions</a></div>
   </dl>
 
   <p>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  <tt>XFAIL: </tt> on a
+  You can easily mark a test as XFAIL just by including <tt>XFAIL: </tt> on a
   line near the top of the file. This signals that the test case should succeed
   if the test fails. Such test cases are counted separately by DejaGnu. To
   specify an expected fail, use the XFAIL keyword in the comments of the test
   program followed by a colon and one or more regular expressions (separated by
-  a comma). The regular expressions allow you to XFAIL the test conditionally
-  by host platform. The regular expressions following the : are matched against
-  the target triplet or llvmgcc version number for the host machine. If there is
-  a match, the test is expected to fail. If not, the test is expected to
-  succeed. To XFAIL everywhere just specify <tt>XFAIL: *</tt>. When matching
-  the llvm-gcc version, you can specify the major (e.g. 3) or full version 
-  (i.e. 3.4) number. Here is an example of an <tt>XFAIL</tt> line:</p>
+  a comma). The regular expressions allow you to XFAIL the test conditionally by
+  host platform. The regular expressions following the : are matched against the
+  target triplet for the host machine. If there is a match, the test is expected
+  to fail. If not, the test is expected to succeed. To XFAIL everywhere just
+  specify <tt>XFAIL: *</tt>. Here is an example of an <tt>XFAIL</tt> line:</p>
 
 <div class="doc_code">
 <pre>
-; XFAIL: darwin,sun,llvmgcc4
+; XFAIL: darwin,sun
 </pre>
 </div>
 
@@ -1106,7 +1135,6 @@ example reports that can do fancy stuff.</p>
 
 </div>
 
-
 <!--=========================================================================-->
 <div class="doc_section"><a name="nightly">Running the nightly tester</a></div>
 <!--=========================================================================-->