Skip to content

Commit

Permalink
[docs] GettingStarted.rst cmake should reference build
Browse files Browse the repository at this point in the history
The next sections in GettingStarted assume you are still in the root
directory llvm-project when using ninja.

Make the `cmake --build` command match it as well.

Note: I am a new cmake user and this confused me.

Reviewed By: MaskRay

Differential Revision: https://reviews.llvm.org/D153727
  • Loading branch information
fzakaria authored and MaskRay committed Jul 15, 2023
1 parent b617669 commit 6fa8d11
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions llvm/docs/GettingStarted.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,11 @@ Getting the Source Code and Building LLVM
you run into memory issues building LLVM, try setting this to limit the
maximum number of compile/link jobs running at the same time.

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

* The default target (i.e. ``cmake --build .`` or ``make``) will build all of
LLVM.
* The default target (i.e. ``cmake --build build`` or ``make -C build``)
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.
Expand Down

0 comments on commit 6fa8d11

Please sign in to comment.