maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

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
This commit is contained in:
Chris Bieneman 2015-03-14 21:20:32 +00:00
parent 7682663ef6
commit 3bec07a34c
2 changed files with 50 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
llvm/docs/BuildingLLVMWithAutotools.rst
View File

@ -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 <GettingStarted.html#check-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 <GettingStarted.html#check-here>`_.
Local LLVM Configuration
------------------------

43
llvm/docs/GettingStarted.rst
View File

@ -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).
* 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-<project>`` target.
* 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``).
* ``--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