X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=docs%2FGettingStartedVS.rst;h=63e81f5165dfe865d610e585ef46668b0fc493c8;hb=9ad8cc389cd0bcf99c9c2a2497e0d8a512abae9e;hp=4c80f2c57bfad8538146132c9ef935312cda807d;hpb=a7aec400a7014edba1eeb53c582d3ab47178fe8d;p=oota-llvm.git diff --git a/docs/GettingStartedVS.rst b/docs/GettingStartedVS.rst index 4c80f2c57bf..63e81f5165d 100644 --- a/docs/GettingStartedVS.rst +++ b/docs/GettingStartedVS.rst @@ -34,7 +34,7 @@ Most of the tools build and work. ``bugpoint`` does build, but does not work. Additional information about the LLVM directory structure and tool chain -can be found on the main `Getting Started `_ page. +can be found on the main :doc:`GettingStarted` page. Requirements @@ -45,22 +45,20 @@ and software you will need. Hardware -------- -Any system that can adequately run Visual Studio 2008 is fine. The LLVM +Any system that can adequately run Visual Studio 2013 is fine. The LLVM source tree and object files, libraries and executables will consume approximately 3GB. Software -------- -You will need Visual Studio 2008 or higher. Earlier versions of Visual -Studio have bugs, are not completely compatible, or do not support the C++ -standard well enough. +You will need Visual Studio 2013 or higher. You will also need the `CMake `_ build system since it generates the project files you will use to build with. If you would like to run the LLVM tests you will need `Python -`_. Versions 2.4-2.7 are known to work. You will need -`GnuWin32 `_ tools, too. +`_. Version 2.7 and newer are known to work. You will +need `GnuWin32 `_ tools, too. Do not install the LLVM directory tree into a path containing spaces (e.g. ``C:\Documents and Settings\...``) as the configure step will fail. @@ -99,8 +97,11 @@ Here's the short story for getting up and running quickly with LLVM: using LLVM. Another important option is ``LLVM_TARGETS_TO_BUILD``, which controls the LLVM target architectures that are included on the build. - * See the `LLVM CMake guide `_ for detailed information about + * See the :doc:`LLVM CMake guide ` for detailed information about how to configure the LLVM build. + * CMake generates project files for all build types. To select a specific + build type, use the Configuration manager from the VS IDE or the + ``/property:Configuration`` command line option when using MSBuild. 6. Start Visual Studio @@ -121,31 +122,32 @@ Here's the short story for getting up and running quickly with LLVM: or run it from the command line. The program will print the corresponding fibonacci value. -8. Test LLVM on Visual Studio: +8. Test LLVM in Visual Studio: * If ``%PATH%`` does not contain GnuWin32, you may specify ``LLVM_LIT_TOOLS_DIR`` on CMake for the path to GnuWin32. * You can run LLVM tests by merely building the project "check". The test results will be shown in the VS output window. -.. FIXME: Is it up-to-date? - -9. Test LLVM: +9. Test LLVM on the command line: * The LLVM tests can be run by changing directory to the llvm source directory and running: .. code-block:: bat - C:\..\llvm> llvm-lit test + C:\..\llvm> python ..\build\bin\llvm-lit --param build_config=Win32 --param build_mode=Debug --param llvm_site_config=../build/test/lit.site.cfg test - Note that quite a few of these test will fail. + This example assumes that Python is in your PATH variable, you + have built a Win32 Debug version of llvm with a standard out of + line build. You should not see any unexpected failures, but will + see many unsupported tests and expected failures. A specific test or test directory can be run with: .. code-block:: bat - C:\..\llvm> llvm-lit test/path/to/test + C:\..\llvm> python ..\build\bin\llvm-lit --param build_config=Win32 --param build_mode=Debug --param llvm_site_config=../build/test/lit.site.cfg test/path/to/test An Example Using the LLVM Tool Chain @@ -161,7 +163,7 @@ An Example Using the LLVM Tool Chain return 0; } -2. Next, compile the C file into a LLVM bitcode file: +2. Next, compile the C file into an LLVM bitcode file: .. code-block:: bat @@ -216,8 +218,8 @@ An Example Using the LLVM Tool Chain Common Problems =============== If you are having problems building or using LLVM, or if you have any other -general questions about LLVM, please consult the `Frequently Asked Questions -`_ page. +general questions about LLVM, please consult the :doc:`Frequently Asked Questions +` page. Links