11# The LLVM Compiler Infrastructure
22
3- This directory and its subdirectories contain source code for LLVM,
3+ This directory and its sub-directories contain source code for LLVM,
44a toolkit for the construction of highly optimized compilers,
5- optimizers, and runtime environments.
5+ optimizers, and run-time environments.
66
77The README briefly describes how to get started with building LLVM.
88For more information on how to contribute to the LLVM project, please
@@ -37,9 +37,9 @@ The LLVM Getting Started documentation may be out of date. The [Clang
3737Getting Started] ( http://clang.llvm.org/get_started.html ) page might have more
3838accurate information.
3939
40- This is an example workflow and configuration to get and build the LLVM source:
40+ This is an example work-flow and configuration to get and build the LLVM source:
4141
42- 1 . Checkout LLVM (including related subprojects like Clang):
42+ 1 . Checkout LLVM (including related sub-projects like Clang):
4343
4444 * `` git clone https://github.com/llvm/llvm-project.git ``
4545
@@ -56,7 +56,7 @@ This is an example workflow and configuration to get and build the LLVM source:
5656
5757 * `` cmake -G <generator> [options] ../llvm ``
5858
59- Some common generators are:
59+ Some common build system generators are:
6060
6161 * `` Ninja `` --- for generating [ Ninja] ( https://ninja-build.org )
6262 build files. Most llvm developers use Ninja.
@@ -68,15 +68,15 @@ This is an example workflow and configuration to get and build the LLVM source:
6868 Some Common options:
6969
7070 * `` -DLLVM_ENABLE_PROJECTS='...' `` --- semicolon-separated list of the LLVM
71- subprojects you'd like to additionally build. Can include any of: clang,
71+ sub-projects you'd like to additionally build. Can include any of: clang,
7272 clang-tools-extra, libcxx, libcxxabi, libunwind, lldb, compiler-rt, lld,
7373 polly, or debuginfo-tests.
7474
7575 For example, to build LLVM, Clang, libcxx, and libcxxabi, use
7676 `` -DLLVM_ENABLE_PROJECTS="clang;libcxx;libcxxabi" `` .
7777
7878 * `` -DCMAKE_INSTALL_PREFIX=directory `` --- Specify for * directory* the full
79- pathname of where you want the LLVM tools and libraries to be installed
79+ path name of where you want the LLVM tools and libraries to be installed
8080 (default `` /usr/local `` ).
8181
8282 * `` -DCMAKE_BUILD_TYPE=type `` --- Valid options for * type* are Debug,
@@ -85,20 +85,21 @@ This is an example workflow and configuration to get and build the LLVM source:
8585 * `` -DLLVM_ENABLE_ASSERTIONS=On `` --- Compile with assertion checks enabled
8686 (default is Yes for Debug builds, No for all other build types).
8787
88- * Run your build tool of choice!
88+ * `` cmake --build . [-- [options] <target>] `` or your build system specified above
89+ directly.
8990
9091 * The default target (i.e. `` ninja `` or `` make `` ) will build all of LLVM.
9192
9293 * The `` check-all `` target (i.e. `` ninja check-all `` ) will run the
9394 regression tests to ensure everything is in working order.
9495
95- * CMake will generate build targets for each tool and library, and most
96+ * CMake will generate targets for each tool and library, and most
9697 LLVM sub-projects generate their own `` check-<project> `` target.
9798
98- * Running a serial build will be * slow* . To improve speed, try running a
99- parallel build. That's done by default in Ninja; for `` make `` , use
100- `` make -j NNN`` ( NNN is the number of parallel jobs, use e.g. number of
101- CPUs you have.)
99+ * Running a serial build will be ** slow* * . To improve speed, try running a
100+ parallel build. That's done by default in Ninja; for `` make `` , use the option
101+ `` -j NNN `` , where `` NNN `` is the number of parallel jobs, e.g. the number of
102+ CPUs you have.
102103
103104 * For more information see [ CMake] ( https://llvm.org/docs/CMake.html )
104105
0 commit comments