RPCS3/llvm-mirror
1
0
Fork 0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-11-22 02:33:06 +01:00
Code Issues Projects Releases Wiki Activity

[docs] Add note on using cmake to perform the build

Browse Source 
Repeat the build instructions from the top level README in the Getting
Started guide.
This commit is contained in:
Evandro Menezes 2020-02-14 13:41:42 -06:00
parent 1165113be8
commit 81503a4556
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/GettingStarted.rst
View File

@ -46,7 +46,7 @@ This is an example workflow and configuration to get and build the LLVM source:
* ``cd build``
* ``cmake -G <generator> [options] ../llvm``
Some common generators are:
Some common build system generators are:
* ``Ninja`` --- for generating `Ninja <https://ninja-build.org>`_
build files. Most llvm developers use Ninja.
@ -75,9 +75,11 @@ This is an example workflow and configuration to get and build the LLVM source:
* ``-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!
* ``cmake --build . [--target <target>]`` or the build system specified
above directly.
* The default target (i.e. ``ninja`` or ``make``) will build all of LLVM.
* The default target (i.e. ``cmake --build .`` or ``make``) will build all of
LLVM.
* The ``check-all`` target (i.e. ``ninja check-all``) will run the
regression tests to ensure everything is in working order.
@ -85,10 +87,10 @@ This is an example workflow and configuration to get and build the LLVM source:
* CMake will generate build targets for each tool and library, and most
LLVM sub-projects generate their own ``check-<project>`` target.
* Running a serial build will be *slow*. To improve speed, try running a
parallel build. That's done by default in Ninja; for ``make``, use
``make -j NNN`` (NNN is the number of parallel jobs, use e.g. number of
CPUs you have.)
* Running a serial build will be **slow**. To improve speed, try running a
parallel build. That's done by default in Ninja; for ``make``, use the
option ``-j NN``, where ``NN`` is the number of parallel jobs, e.g. the
number of available CPUs.
* For more information see `CMake <CMake.html>`__