[llvm] 6fa8d11 - [docs] GettingStarted.rst cmake should reference build

Fangrui Song via llvm-commits llvm-commits at lists.llvm.org
Sat Jul 15 11:36:18 PDT 2023


Author: Farid Zakaria
Date: 2023-07-15T11:36:13-07:00
New Revision: 6fa8d110342dccd99fdc926c057e33adc4cc2ffb

URL: https://github.com/llvm/llvm-project/commit/6fa8d110342dccd99fdc926c057e33adc4cc2ffb
DIFF: https://github.com/llvm/llvm-project/commit/6fa8d110342dccd99fdc926c057e33adc4cc2ffb.diff

LOG: [docs] GettingStarted.rst cmake should reference build

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

Added: 
    

Modified: 
    llvm/docs/GettingStarted.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/GettingStarted.rst b/llvm/docs/GettingStarted.rst
index a3e0903122e094..96135b73ca21ab 100644
--- a/llvm/docs/GettingStarted.rst
+++ b/llvm/docs/GettingStarted.rst
@@ -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.


        


More information about the llvm-commits mailing list