From: Reid Spencer <rspencer@reidspencer.com>
Date: Sun, 9 Apr 2006 23:45:38 +0000 (+0000)
Subject: Update docs for ENABLE_ASSERTIONS -> DISABLE_ASSERTIONS
X-Git-Url: http://plrg.eecs.uci.edu/git/?a=commitdiff_plain;ds=sidebyside;h=004ba03a466f0f66e45d88320495ea8c949665f4;hp=f9f431c3b5bed1505055bd79a1dc8e723380021e;p=oota-llvm.git

Update docs for ENABLE_ASSERTIONS -> DISABLE_ASSERTIONS


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@27553 91177308-0d34-0410-b5e6-96231b3b80d8
---

diff --git a/docs/GettingStarted.html b/docs/GettingStarted.html
index d0a48e09072..e9a725ecdf0 100644
--- a/docs/GettingStarted.html
+++ b/docs/GettingStarted.html
@@ -955,9 +955,9 @@ declaring variables on the command line.  The following are some examples:</p>
   Perform a Release (Optimized) build.
   <p>
 
-  <dt><tt>gmake ENABLE_OPTIMIZED=1 ENABLE_ASSERTIONS=1</tt>
+  <dt><tt>gmake ENABLE_OPTIMIZED=1 DISABLE_ASSERTIONS=1</tt>
   <dd>
-  Perform a Release (Optimized) build with assertions enabled.
+  Perform a Release (Optimized) build without assertions enabled.
   <p>
 
   <dt><tt>gmake ENABLE_PROFILING=1</tt>
diff --git a/docs/MakefileGuide.html b/docs/MakefileGuide.html
index 27dc361cec8..54f6b22f6d9 100644
--- a/docs/MakefileGuide.html
+++ b/docs/MakefileGuide.html
@@ -632,10 +632,11 @@
     to the compilers and linkers to ensure that profile data can be collected
     from the tools built. Use the <tt>gprof</tt> tool to analyze the output from
     the profiled tools (<tt>gmon.out</tt>).</dd>
-    <dt><a name="ENABLE_ASSERTIONS"><tt>ENABLE_ASSERTIONS</tt></a></dt>
-    <dd>If set to any value, causes the build to enable assertions, even if 
-    building a release or profile build.  This is slower than a release build 
-    but far faster than a debug build.</dd>
+    <dt><a name="DISABLE_ASSERTIONS"><tt>DISABLE_ASSERTIONS</tt></a></dt>
+    <dd>If set to any value, causes the build to disable assertions, even if 
+    building a release or profile build.  This will exclude all assertion check
+    code from the build. LLVM will execute faster, but with little help when
+    things go wrong.</dd>
     <dt><a name="EXPERIMENTAL_DIRS"><tt>EXPERIMENTAL_DIRS</tt></a></dt>
     <dd>Specify a set of directories that should be built, but if they fail, it
     should not cause the build to fail. Note that this should only be used