Improve the Getting Started and Hacking web pages, patch by

John Thompson!

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

diff --git a/www/get_started.html b/www/get_started.html
index 690a91120d16a209ed7124b8a1d8864468067506..a2706231b6d82a428829168bdc1465efbf5b098c 100644 (file)
--- a/www/get_started.html
+++ b/www/get_started.html
@@ -59,26 +59,28 @@ follows:</p>
       http://www.python.org/download</a></li>
   </ul>
 
-  <li><a href="http://www.llvm.org/docs/GettingStarted.html#checkout">Checkout
-   and build LLVM</a> from SVN head:</li>
-
+  <li>Checkout LLVM:</li>
   <ul>
+    <li>Change directory to where you want the llvm directory placed.</li>
     <li><tt>svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm</tt></li>
-    <li><tt>cd llvm</tt></li>
-    <li><tt>./configure; make</tt></li>
   </ul>
   <li>Checkout Clang:</li>
   <ul>
-     <li>From within the <tt>llvm</tt> directory (where you
-     built llvm):</li>
-     <li><tt>cd tools</tt>
-     <li><tt>svn co http://llvm.org/svn/llvm-project/cfe/trunk clang</tt></li>
-
+    <li><tt>cd llvm/tools</tt>
+    <li><tt>svn co http://llvm.org/svn/llvm-project/cfe/trunk clang</tt></li>
+  </ul>
+  <li>Build LLVM and Clang:</li>
+  <ul>
+    <li><tt>cd ..</tt>  (back to llvm)</li>
+    <li><tt>./configure</tt></li>
+    <li><tt>make</tt></li>
+    <li>This builds both LLVM and Clang for debug mode.</li>
+    <li>Note: For subsequent Clang development, you can just do make at the
+    clang directory level.</li>
   </ul>
   <li>If you intend to work on Clang C++ support, you may need to tell it how
       to find your C++ standard library headers.  If Clang cannot find your 
       system libstdc++ headers, please follow these instructions:</li>
-
   <ul>
     <li>'<tt>touch empty.cpp; gcc -v empty.cpp -fsyntax-only</tt>' to get the
     path.</li>
@@ -86,13 +88,6 @@ follows:</p>
     hard-coded paths" in <tt>clang/lib/Frontend/InitHeaderSearch.cpp</tt> and
     change the lines below to include that path.</li>
   </ul>
-
-  <li>Build Clang:</li>
-  <ul>
-    <li><tt>cd clang</tt> (assuming that you are in <tt>llvm/tools</tt>)</li>
-    <li><tt>make</tt> (this will give you a debug build)</li>
-  </ul>
-
   <li>Try it out (assuming you add llvm/Debug/bin to your path):</li>
   <ul>
     <li><tt>clang-cc --help</tt></li>
@@ -107,7 +102,6 @@ follows:</p>
     <li><tt>clang-cc file.c -emit-llvm -o - | llvm-as | opt -std-compile-opts | llc
          &gt; file.s</tt> (output native machine code)</li>
   </ul>
-  
   <p><em>Note</em>: Here <tt>clang-cc</tt> is the "low-level" frontend
   executable that is similar in purpose to <tt>cc1</tt>. Clang also has a <a
   href="#driver">high-level compiler driver</a> that acts as a drop-in
@@ -149,11 +143,18 @@ Visual Studio:</p>
         http://www.cmake.org/cmake/resources/software.html</a></li>
     <li><b>Visual Studio 2005</b>
         (VS 2008 may work also - cmake outputs VS2005 project files)</li>
-    <li><b>Python</b>.  This is need only if you will be running the tests
+    <li><b>Python</b>.  This is needed only if you will be running the tests
         (which is essential, if you will be developing for clang).
         Get it from:
         <a href="http://www.python.org/download">
         http://www.python.org/download</a></li>
+    <li><b>GnuWin32 tools</b>
+        These are also necessary for running the tests.
+        (Note that the grep from MSYS or Cygwin doesn't work with the tests
+        because of embedded double-quotes in the search strings.  The GNU
+        grep does work in this case.)
+        Get them from <a href="http://getgnuwin32.sourceforge.net">
+        http://getgnuwin32.sourceforge.net</a>.</li>
   </ul>
 
   <li>Checkout LLVM:</li>

diff --git a/www/hacking.html b/www/hacking.html
index 45553222798f80cadd2cd5e9ff1c674c7b4089f6..a1833a2326c951e7254fc38b15cea70d3c3cab4f 100644 (file)
--- a/www/hacking.html
+++ b/www/hacking.html
@@ -136,6 +136,13 @@
   Python, which must be installed.  Find Python at:
   <a href="http://www.python.org/download">http://www.python.org/download</a>.
   Download the latest stable version (2.6.2 at the time of this writing).</p>
+  
+  <p>The GnuWin32 tools are also necessary for running the tests.
+  (Note that the grep from MSYS or Cygwin doesn't work with the tests
+  because of embedded double-quotes in the search strings.  The GNU
+  grep does work in this case.)
+  Get them from <a href="http://getgnuwin32.sourceforge.net">
+  http://getgnuwin32.sourceforge.net</a>.</p>
 
   <!--=====================================================================-->
   <h2 id="patches">Creating Patch Files</h2>