Describe the new "reconfigure" and "spotless" targets.
authorReid Spencer <rspencer@reidspencer.com>
Fri, 17 Dec 2004 07:46:45 +0000 (07:46 +0000)
committerReid Spencer <rspencer@reidspencer.com>
Fri, 17 Dec 2004 07:46:45 +0000 (07:46 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@19013 91177308-0d34-0410-b5e6-96231b3b80d8

docs/MakefileGuide.html

index 7e70f3aabed64f8a3672ad54af9dcf22a6ee0320..64fe536cb6f98bc8ed917afb5bd8496a72d677b6 100644 (file)
@@ -54,6 +54,8 @@
       <li><a href="#install">install</a></li>
       <li><a href="#preconditions">preconditions</a></li>
       <li><a href="#printvars">printvars</a></li>
+      <li><a href="#reconfigure">reconfigure</a></li>
+      <li><a href="#spotless">spotless</a></li>
       <li><a href="#tags">tags</a></li>
       <li><a href="#uninstall">uninstall</a></li>
     </ol>
   the makefile variables so that you can double check how things are set. </p>
 </div>
 
+<!-- ======================================================================= -->
+<div class="doc_subsection"><a name="reconfigure">reconfigure</a></div>
+<div class="doc_text">
+  <p>This utility target will force a reconfigure of LLVM or your project. It 
+  simply runs <tt>$(BUILD_OBJ_ROOT)/config.status --recheck</tt> to rerun the
+  configuration tests and rebuild the configured files. This isn't generally
+  useful as the makefiles will reconfigure themselves whenever its necessary.
+  </p>
+</div>
+
+<!-- ======================================================================= -->
+<div class="doc_subsection"><a name="spotless">spotless</a></div>
+<div class="doc_text">
+  <p>This utility target, only available when <tt>$(BUILD_OBJ_ROOT)</tt> is not 
+  the same as <tt>$(BUILD_SRC_ROOT)</tt>, will completely clean the
+  <tt>$(BUILD_OBJ_ROOT)</tt> directoy by removing its content entirely and 
+  reconfiguring the directory. This returns the <tt>$(BUILD_OBJ_ROOT)</tt> 
+  directory to a completely fresh state. All content in the directory except 
+  configured files and top-level makefiles will be lost.
+  <font color="red">Use with caution.</font></p>
+</div>
+
 <!-- ======================================================================= -->
 <div class="doc_subsection"><a name="tags">tags</a></div>
 <div class="doc_text">