Describe how to configure tests to work with f2c

llvm-svn: 16829

1 files changed, 26 insertions, 0 deletions

diff --git a/llvm/docs/TestingGuide.html b/llvm/docs/TestingGuide.html
index a6a44efff11..ec9e40bc6f7 100644
--- a/llvm/docs/TestingGuide.html
+++ b/llvm/docs/TestingGuide.html
@@ -65,6 +65,32 @@ any other version.</b></dd>
 need zlib and SAX support enabled.</dd>
 </dl>
 
+<dt><a href="http://www.netlib.org/f2c">F2C</A></dt>
+<dd>For now, LLVM does not have a Fortran front-end, but using F2C, we can run
+Fortran benchmarks.  F2C support must be enabled via <tt>configure</tt> if not
+installed in a standard place.  F2C requires three items: the <tt>f2c</tt>
+executable, <tt>f2c.h</tt> to compile the generated code, and <tt>libf2c.a</tt>
+to link generated code.  By default, given an F2C directory <tt>$DIR</tt>, the
+configure script will search <tt>$DIR/bin</tt> for <tt>f2c</tt>,
+<tt>$DIR/include</tt> for <tt>f2c.h</tt>, and <tt>$DIR/lib</tt> for
+<tt>libf2c.a</tt>.  The default <tt>$DIR</tt> values are: <tt>/usr</tt>,
+<tt>/usr/local</tt>, <tt>/sw</tt>, and <tt>/opt</tt>.  If you installed F2C in a
+different location, you must tell <tt>configure</tt>:
+
+<ul>
+<li><tt>./configure --with-f2c=$DIR</tt><br>
+This will specify a new <tt>$DIR</tt> for the above-described search
+process.  This will only work if the binary, header, and library are in their
+respective subdirectories of <tt>$DIR</tt>.</li>
+
+<li><tt>./configure --with-f2c-bin=/binary/path --with-f2c-inc=/include/path
+--with-f2c-lib=/lib/path</tt><br>
+This allows you to specify the F2C components separately.  Note: if you choose
+this route, you MUST specify all three components, and you need to only specify
+<em>directories</em> where the files are located; do NOT include the
+filenames themselves on the <tt>configure</tt> line.</li>
+</ul></dd>
+</dl>
 </div>
 
 <!--=========================================================================-->