Forgot this.
[oota-llvm.git] / docs / GettingStartedVS.html
index a09559ed8e6263f5f267744b138b38bac627624c..5a86199f7e4d6de8f63df90b1132c8ae7d148b4f 100644 (file)
   <p>The LLVM test suite cannot be run on the Visual Studio port at this
   time.</p>
 
-  <p>Most of the tools build and work.  <tt>llvm-db</tt> does not build at this
-  time.  <tt>bugpoint</tt> does build, but does not work.
+  <p>Most of the tools build and work.  <tt>bugpoint</tt> does build, but does
+  not work.  The other tools 'should' work, but have not been fully tested.</p>
 
   <p>Additional information about the LLVM directory structure and tool chain
   can be found on the main <a href="GettingStarted.html">Getting Started</a>
-  page.</P>
+  page.</p>
 
 </div>
 
       <li><tt>cd llvm</tt></li>
     </ol></li>
   </ul></li>
+  
+  <li> Use <a href="http://www.cmake.org/">CMake</a> to generate up-to-date
+    project files:
+    <ul><li>This step is currently optional as LLVM does still come with a
+    normal Visual Studio solution file, but it is not always kept up-to-date
+    and will soon be deprecated in favor of the multi-platform generator
+    CMake.</li>
+    <li>If CMake is installed then the most simple way is to just start the
+    CMake GUI, select the directory where you have LLVM extracted to, and
+    the default options should all be fine.  The one option you may really
+    want to change, regardless of anything else, might be the
+    CMAKE_INSTALL_PREFIX setting to select a directory to INSTALL to once
+    compiling is complete.</li>
+    <li>If you use CMake to generate the Visual Studio solution and project
+    files, then the Solution will have a few extra options compared to the
+    current included one.  The projects may still be built individually, but
+    to build them all do not just select all of them in batch build (as some
+    are meant as configuration projects), but rather select and build just
+    the ALL_BUILD project to build everything, or the INSTALL project, which
+    first builds the ALL_BUILD project, then installs the LLVM headers, libs,
+    and other useful things to the directory set by the CMAKE_INSTALL_PREFIX
+    setting when you first configured CMake.</li>
+    </ul>
+  </li>
 
   <li>Start Visual Studio
-  <ol>
-    <li>Simply double click on the solution file <tt>llvm/win32/llvm.sln</tt>.
-    </li>
-  </ol></li>
+  <ul>
+    <li>If you did not use CMake, then simply double click on the solution
+    file <tt>llvm/win32/llvm.sln</tt>.</li>
+    <li>If you used CMake, then the directory you created the project files,
+    the root directory will have an <tt>llvm.sln</tt> file, just
+    double-click on that to open Visual Studio.</li>
+  </ul></li>
 
   <li>Build the LLVM Suite:
-  <ol>
+  <ul>
     <li>Simply build the solution.</li>
     <li>The Fibonacci project is a sample program that uses the JIT.  Modify
     the project's debugging properties to provide a numeric command line
     argument.  The program will print the corresponding fibonacci value.</li>
-  </ol></li>
+  </ul></li>
 
 </ol>
 
@@ -151,8 +178,8 @@ changes are continually making the VS support better.</p>
 
 <div class="doc_text">
 
-  <p>Any system that can adequately run Visual Studio .NET 2003 is fine.  The
-  LLVM source tree and object files, libraries and executables will consume
+  <p>Any system that can adequately run Visual Studio .NET 2005 SP1 is fine.  
+  The LLVM source tree and object files, libraries and executables will consume
   approximately 3GB.</p>
 
 </div>
@@ -161,16 +188,15 @@ changes are continually making the VS support better.</p>
 <div class="doc_subsection"><a name="software"><b>Software</b></a></div>
 <div class="doc_text">
 
-  <p>You will need Visual Studio .NET 2003.  Earlier versions cannot open the
-  solution/project files.  The VS 2005 beta can, but will migrate these files
-  to its own format in the process.  While it should work with the VS 2005
-  beta, there are no guarantees and there is no support for it at this time.
-  It has been reported that VC++ Express also works.</p>
-
-  <p>If you plan to modify any .y or .l files, you will need to have bison
-  and/or flex installed where Visual Studio can find them.  Otherwise, you do
-  not need them and the pre-generated files that come with the source tree
-  will be used.</p>
+  <p>You will need Visual Studio .NET 2005 SP1 or higher.  The VS2005 SP1
+  beta and the normal VS2005 still have bugs that are not completely
+  compatible. VS2003 would work except (at last check) it has a bug with
+  friend classes that you can work-around with some minor code rewriting
+  (and please submit a patch if you do).  Earlier versions of Visual Studio
+  do not support the C++ standard well enough and will not work.</p>
+  
+  <p>You will also need the <a href="http://www.cmake.org/">CMake</a> build
+  system since it generates the project files you will use to build with.</p>
 
   <p>
   Do not install the LLVM directory tree into a path containing spaces (e.g.
@@ -311,9 +337,9 @@ int main() {
 </pre>
 </div>
 
-      <p>Note: this will only work for trivial C programs.  Non-trivial programs
-        (and any C++ program) will have dependencies on the GCC runtime that
-        won't be satisfied by the Microsoft runtime libraries.</p></li>
+    <p>Note: this will only work for trivial C programs.  Non-trivial programs
+      (and any C++ program) will have dependencies on the GCC runtime that won't
+      be satisfied by the Microsoft runtime libraries.</p></li>
 
   <li><p>Execute the native code program:</p>
 
@@ -334,6 +360,17 @@ int main() {
 
 <div class="doc_text">
 
+  <ul>
+    <li>In Visual C++, if you are linking with the x86 target statically, the
+    linker will remove the x86 target library from your generated executable or
+    shared library because there are no references to it. You can force the
+    linker to include these references by using
+    <tt>"/INCLUDE:_X86TargetMachineModule"</tt> when linking. In the Visual
+    Studio IDE, this can be added in
+<tt>Project&nbsp;Properties->Linker->Input->Force&nbsp;Symbol&nbsp;References</tt>.
+    </li>
+  </ul>
+
 <p>If you are having problems building or using LLVM, or if you have any other
 general questions about LLVM, please consult the <a href="FAQ.html">Frequently
 Asked Questions</a> page.</p>
@@ -368,9 +405,9 @@ out:</p>
 <hr>
 <address>
   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
-  src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
+  src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
   <a href="http://validator.w3.org/check/referer"><img
-  src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
+  src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
 
   <a href="mailto:jeffc@jolt-lang.org">Jeff Cohen</a><br>
   <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>