Update failing SingleSource test-case list.
[oota-llvm.git] / docs / MakefileGuide.html
index a82bfaf16b2d48a5e2f2e1517732103895a36c01..422a00ef34ed4cd044a4f186545ad8edf3f74c2d 100644 (file)
   <tt>Makefile</tt>. This is the file first read by <tt>make</tt>. It has three
   sections:</p>
   <ol>
-    <li><a href="setvars">Settable Variables</a> - Required that must be set
+    <li><a href="#setvars">Settable Variables</a> - Required that must be set
     first.</li>
-    <li><a href="Makefile.common">include <tt>$(LEVEL)/Makefile.common</tt></a>
+    <li><a href="#Makefile.common">include <tt>$(LEVEL)/Makefile.common</tt></a>
     - include the LLVM Makefile system.
-    <li><a href="overvars">Override Variables</a> - Override variables set by
+    <li><a href="#overvars">Override Variables</a> - Override variables set by
     the LLVM Makefile system.
   </ol>
 </div>
   <ol>
     <li>It includes the project's configuration makefile to obtain values
     determined by the <tt>configure</tt> script. This is done by including the
-    <a href="Makefile.config"><tt>$(LEVEL)/Makefile.config</tt></a> file.</li>
+    <a href="#Makefile.config"><tt>$(LEVEL)/Makefile.config</tt></a> file.</li>
     <li>It specifies any other (static) values that are needed throughout the
     project. Only values that are used in all or a large proportion of the
     project's directories should be placed here.</li>
     <li>It includes the standard rules for the LLVM Makefile system,
-    <a href="Makefile.rules"><tt>$(LLVM_SRC_ROOT)/Makefile.rules</tt></a>. 
+    <a href="#Makefile.rules"><tt>$(LLVM_SRC_ROOT)/Makefile.rules</tt></a>. 
     This file is the "guts" of the LLVM Makefile system.</li>
   </ol>
 </div>
   <p>This file, located at <tt>$(LLVM_SRC_ROOT)/Makefile.rules</tt> is the heart
   of the LLVM Makefile System. It provides all the logic, dependencies, and
   rules for building the targets supported by the system. What it does largely
-  depends on the values of <tt>make</tt> <a href="variables">variables</a> that
+  depends on the values of <tt>make</tt> <a href="#variables">variables</a> that
   have been set <em>before</em> <tt>Makefile.rules</tt> is included.
 </div>
 
 <div class="doc_subsection"><a name="setvars">Control Variables</a></div>
 <div class="doc_text">
   <p>Variables listed in the table below should be set <em>before</em> the 
-  inclusion of <a href="Makefile.common"><tt>$(LEVEL)/Makefile.common</tt></a>. 
+  inclusion of <a href="#Makefile.common"><tt>$(LEVEL)/Makefile.common</tt></a>.
   These variables provide input to the LLVM make system that tell it what to do 
   for the current directory.</p>
   <dl>
     <dt><a name="TOOLNAME"><tt>TOOLNAME</tt></a></dt>
     <dd>Specifies the name of the tool that the current directory should
     build.</dd>
+    <dt><a name="TOOL_VERBOSE"><tt>TOOL_VERBOSE</tt></a></dt>
+    <dd>Implies VERBOSE and also tells each tool invoked to be verbose. This is
+    handy when you're trying to see the sub-tools invoked by each tool invoked 
+    by the makefile. For example, this will pass <tt>-v</tt> to the GCC 
+    compilers which causes it to print out the command lines it uses to invoke
+    sub-tools (compiler, assembler, linker).</dd>
     <dt><a name="USEDLIBS"><tt>USEDLIBS</tt></a></dt>
     <dd>Specifies the list of project libraries that will be linked into the
     tool or library.</dd>
     <li>On the <tt>make</tt> command line -- recommended.</li>
     <li>On the <tt>configure</tt> command line</li>
     <li>In the Makefile (only <em>after</em> the inclusion of <a
-    href="Makefile.common"><tt>$(LEVEL)/Makefile.common</tt></a>.</li>
+    href="#Makefile.common"><tt>$(LEVEL)/Makefile.common</tt></a>).</li>
   </ul>
   <p>The overridable variables are given below:</p>
   <dl>
     <dt><a name="Sources"><tt>Sources</tt></a></dt>
     <dd>The complete list of source files.</dd>
     <dt><a name="sysconfdir"><tt>sysconfdir</tt></a></dt>
-    <dd>The directory into which configuration files will ulitmately be
+    <dd>The directory into which configuration files will ultimately be
     installed. This value is derived from the <tt>--prefix</tt> option given to
     <tt>configure</tt>.</dd>
     <dt><a name="ToolDir"><tt>ToolDir</tt></a></dt>