diff options
| author | Dmitri Gribenko <gribozavr@gmail.com> | 2013-01-05 18:10:06 +0000 |
|---|---|---|
| committer | Dmitri Gribenko <gribozavr@gmail.com> | 2013-01-05 18:10:06 +0000 |
| commit | 8b2bcf4f753be8100fc712d6267f38b21085fc13 (patch) | |
| tree | 4b3d2013dd7f5e8ec1d2a580f47f1fbf8d2cbc9c /docs/GettingStarted.rst | |
| parent | 36e4bc406ca93f5ebd8e8b67cbf5d236c8423cbe (diff) | |
| download | llvm-8b2bcf4f753be8100fc712d6267f38b21085fc13.tar.gz llvm-8b2bcf4f753be8100fc712d6267f38b21085fc13.tar.bz2 llvm-8b2bcf4f753be8100fc712d6267f38b21085fc13.tar.xz | |
GettingStarted: improve formatting and document that configure checks for
'clang' to use it as the compiler.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@171630 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/GettingStarted.rst')
| -rw-r--r-- | docs/GettingStarted.rst | 34 |
1 files changed, 16 insertions, 18 deletions
diff --git a/docs/GettingStarted.rst b/docs/GettingStarted.rst index e37eab91cd..3605686f16 100644 --- a/docs/GettingStarted.rst +++ b/docs/GettingStarted.rst @@ -71,27 +71,24 @@ Here's the short story for getting up and running quickly with LLVM: * ``../llvm/configure [options]`` Some common options: - * ``--prefix=directory`` --- + * ``--prefix=directory`` --- Specify for *directory* the full pathname of + where you want the LLVM tools and libraries to be installed (default + ``/usr/local``). - 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-optimized`` --- - - Compile with optimizations enabled (default is NO). - - * ``--enable-assertions`` --- - - Compile with assertion checks enabled (default is YES). + * ``--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 --enabled-optimized configure option is used to specify a Release + The ``--enabled-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. - + * ``make update`` --- This command is used to update all the svn repositories at once, rather then having to ``cd`` into the individual repositories and running ``svn update``. @@ -664,14 +661,15 @@ configure the build system: | Variable | Purpose | +============+===========================================================+ | CC | Tells ``configure`` which C compiler to use. By default, | -| | ``configure`` will look for the first GCC C compiler in | -| | ``PATH``. Use this variable to override ``configure``\'s | -| | default behavior. | +| | ``configure`` will check ``PATH`` for ``clang`` and GCC C | +| | compilers (in this order). Use this variable to override | +| | ``configure``\'s default behavior. | +------------+-----------------------------------------------------------+ | CXX | Tells ``configure`` which C++ compiler to use. By | -| | default, ``configure`` will look for the first GCC C++ | -| | compiler in ``PATH``. Use this variable to override | -| | ``configure``'s default behavior. | +| | default, ``configure`` will check ``PATH`` for | +| | ``clang++`` and GCC C++ compilers (in this order). Use | +| | this variable to override ``configure``'s default | +| | behavior. | +------------+-----------------------------------------------------------+ The following options can be used to set or enable LLVM specific options: |