From 3bec07a34c6bc3ca079f3d09aeb7c26a97c483b0 Mon Sep 17 00:00:00 2001 From: Chris Bieneman Date: Sat, 14 Mar 2015 21:20:32 +0000 Subject: [PATCH] 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 --- llvm/docs/BuildingLLVMWithAutotools.rst | 35 ++++++++++++++++++++ llvm/docs/GettingStarted.rst | 43 +++++++++---------------- 2 files changed, 50 insertions(+), 28 deletions(-) diff --git a/llvm/docs/BuildingLLVMWithAutotools.rst b/llvm/docs/BuildingLLVMWithAutotools.rst index 975195039873..4c04f1e1865c 100644 --- a/llvm/docs/BuildingLLVMWithAutotools.rst +++ b/llvm/docs/BuildingLLVMWithAutotools.rst @@ -8,6 +8,41 @@ Building LLVM With Autotools Overview ======== +This document details how to use the LLVM autotools based build system to +configure and build LLVM from source. The normal developer process using CMake +is detailed `here `_. + +A Quick Summary +--------------- + +#. Configure and build LLVM and Clang: + + * ``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``). + + * ``--enable-optimized`` --- Compile with optimizations enabled (default + is NO). + + * ``--enable-assertions`` --- Compile with assertion checks enabled + (default is YES). + + * ``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. + + * ``make check-all`` --- This run the regression tests to ensure everything + is in working order. + + * If you get an "internal compiler error (ICE)" or test failures, see + `here `_. Local LLVM Configuration ------------------------ diff --git a/llvm/docs/GettingStarted.rst b/llvm/docs/GettingStarted.rst index 7e223b928d57..18b3c1d87cc6 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 `_. If you would rather use + autotools, see `Building LLVM with autotools `_. * ``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). + * Run your build tool of choice! + + * The default target (i.e. ``make``) will build all of LLVM + + * The ``check-all`` target (i.e. ``make check-all``) will run the + regression tests to ensure everything is in working order. + + * CMake will generate build targets for each tool and library, and most + LLVM sub-projects generate their own ``check-`` target. + * For more information see `CMake `_ -#. 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``). - - * ``--enable-optimized`` --- Compile with optimizations enabled (default - is NO). - - * ``--enable-assertions`` --- Compile with assertion checks enabled - (default is YES). - - * ``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. - - * ``make check-all`` --- This run the regression tests to ensure everything - is in working order. - * 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