Skip to content

Commit

Permalink
[doc] Use cmake's -S option to simplify the build instructions
Browse files Browse the repository at this point in the history
Now that llvm's minimum version is 3.13.4 anyway and `-S` is
introduced in the same version[1], let's use this little
time saving option to simplify the build instructions.

[1]: https://cgold.readthedocs.io/en/latest/glossary/-S.html

Authored-By: Ebrahim Byagowi <ebrahim@gnu.org>

Differential-Revision: https://reviews.llvm.org/D95049
  • Loading branch information
ebraminio authored and Evandro Menezes committed Feb 16, 2021
1 parent b86dbe0 commit 8eda10c
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,7 @@ This is an example work-flow and configuration to get and build the LLVM source:

* ``cd llvm-project``

* ``mkdir build``

* ``cd build``

* ``cmake -G <generator> [options] ../llvm``
* ``cmake -S llvm -B build -G <generator> [options]``

Some common build system generators are:

Expand Down Expand Up @@ -85,7 +81,7 @@ This is an example work-flow 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).

* ``cmake --build . [-- [options] <target>]`` or your build system specified above
* ``cmake --build build [-- [options] <target>]`` or your build system specified above
directly.

* The default target (i.e. ``ninja`` or ``make``) will build all of LLVM.
Expand Down

0 comments on commit 8eda10c

Please sign in to comment.