diff options
author | Chris Bieneman <beanz@apple.com> | 2015-03-14 21:20:32 +0000 |
---|---|---|
committer | Chris Bieneman <beanz@apple.com> | 2015-03-14 21:20:32 +0000 |
commit | 3bec07a34c6bc3ca079f3d09aeb7c26a97c483b0 (patch) | |
tree | 6ad3847757062c33ed1b43b6598d5db32ea09978 /llvm/docs/GettingStarted.rst | |
parent | 7682663ef6a656440baeb05bbd5f97545c0c8fd8 (diff) | |
download | bcm5719-llvm-3bec07a34c6bc3ca079f3d09aeb7c26a97c483b0.tar.gz bcm5719-llvm-3bec07a34c6bc3ca079f3d09aeb7c26a97c483b0.zip |
A few minor updates based on feedback from Justin and a few things I thought were missing.
* Moved autotools configure & build example out of "Getting Started Quickly (A Summary)" and into BuildingLLVMWithAutoTools.
* Removed the annotations that CMake is the recommended process and Autotools is alternate.
* Added brief documentation about build targets under "Getting Started Quickly..."
* Added Overview text to BuildingLLVMWithAutotools
* Fixed up a broken link.
llvm-svn: 232278
Diffstat (limited to 'llvm/docs/GettingStarted.rst')
-rw-r--r-- | llvm/docs/GettingStarted.rst | 37 |
1 files changed, 12 insertions, 25 deletions
diff --git a/llvm/docs/GettingStarted.rst b/llvm/docs/GettingStarted.rst index 7e223b928d5..18b3c1d87cc 100644 --- a/llvm/docs/GettingStarted.rst +++ b/llvm/docs/GettingStarted.rst @@ -61,7 +61,10 @@ Here's the short story for getting up and running quickly with LLVM: * ``cd llvm/projects`` * ``svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite`` -#. Configure and build LLVM and Clang (Recommended process using CMake): +#. Configure and build LLVM and Clang: + + The usual build uses `CMake <CMake.html>`_. If you would rather use + autotools, see `Building LLVM with autotools <BuildingLLVMWithAutotools.html>`_. * ``cd where you want to build llvm`` * ``mkdir build`` @@ -89,36 +92,20 @@ Here's the short story for getting up and running quickly with LLVM: * ``-DLLVM_ENABLE_ASSERTIONS=On`` --- Compile with assertion checks enabled (default is Yes for Debug builds, No for all other build types). - * For more information see `CMake <CMake.html>`_ - -#. Configure and build LLVM and Clang (Alternate process using configure): - - * ``cd where-you-want-to-build-llvm`` - * ``mkdir build`` (for building without polluting the source dir) - * ``cd build`` - * ``../llvm/configure [options]`` - Some common options: - - * ``--prefix=directory`` --- Specify for *directory* the full pathname of - where you want the LLVM tools and libraries to be installed (default - ``/usr/local``). + * Run your build tool of choice! - * ``--enable-optimized`` --- Compile with optimizations enabled (default - is NO). + * The default target (i.e. ``make``) will build all of LLVM - * ``--enable-assertions`` --- Compile with assertion checks enabled - (default is YES). + * The ``check-all`` target (i.e. ``make check-all``) will run the + regression tests to ensure everything is in working order. - * ``make [-j]`` --- The ``-j`` specifies the number of jobs (commands) to run - simultaneously. This builds both LLVM and Clang for Debug+Asserts mode. - The ``--enable-optimized`` configure option is used to specify a Release - build. + * CMake will generate build targets for each tool and library, and most + LLVM sub-projects generate their own ``check-<project>`` target. - * ``make check-all`` --- This run the regression tests to ensure everything - is in working order. + * For more information see `CMake <CMake.html>`_ * If you get an "internal compiler error (ICE)" or test failures, see - `below`. + `below`_. Consult the `Getting Started with LLVM`_ section for detailed information on configuring and compiling LLVM. See `Setting Up Your Environment`_ for tips |