[PATCH] D95049: [doc] Use cmake's -S option to simplify the build instructions

[Ebrahim Byagowi via Phabricator via llvm-commits]

ebraminio created this revision.
ebraminio added a reviewer: evandro.
ebraminio requested review of this revision.
Herald added a project: LLVM.
Herald added a subscriber: llvm-commits.

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


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D95049

Files:
  README.md


Index: README.md
===================================================================
--- README.md
+++ README.md
@@ -50,11 +50,7 @@
 
      * ``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:
 
@@ -85,7 +81,7 @@
         * ``-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.


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D95049.317872.patch
Type: text/x-patch
Size: 847 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20210120/a3a482b1/attachment.bin>