RPCSX/llvm
1
0
Fork 0
mirror of https://github.com/RPCSX/llvm.git synced 2025-02-04 11:27:34 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

GettingStarted: improve formatting and document that configure checks for

Browse Source 
'clang' to use it as the compiler.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@171630 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Dmitri Gribenko 2013-01-05 18:10:06 +00:00
parent 36e4bc406c
commit 8b2bcf4f75
1 changed files with 16 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/GettingStarted.rst
View File

@ -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: