[PATCH] D145714: [docs] Mention LLVM_USE_LINKER/LLVM_PARALLEL_{COMPILE,LINK}_JOBS in GettingStarted

[Arthur Eubanks via Phabricator via llvm-commits]

aeubanks created this revision.
aeubanks added a reviewer: aaron.ballman.
Herald added a project: All.
aeubanks requested review of this revision.
Herald added a project: LLVM.
Herald added a subscriber: llvm-commits.

As requested in D145413 <https://reviews.llvm.org/D145413>.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D145714

Files:
  llvm/docs/GettingStarted.rst


Index: llvm/docs/GettingStarted.rst
===================================================================
--- llvm/docs/GettingStarted.rst
+++ llvm/docs/GettingStarted.rst
@@ -79,6 +79,16 @@
      * ``-DLLVM_ENABLE_ASSERTIONS=ON`` --- Compile with assertion checks enabled
        (default is ON for Debug builds, OFF for all other build types).
 
+     * ``-DLLVM_USE_LINKER=lld`` --- Link with the `lld linker`_, assuming it
+       is installed on your system. This can dramatically speed up link times
+       if the default linker is slow.
+
+     * ``-DLLVM_PARALLEL_{COMPILE,LINK}_JOBS=N`` --- Limit the number of
+       compile/link jobs running in parallel at the same time. This is
+       especially important for linking since linking can use lots of memory. If
+       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
      above directly.
 


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D145714.503861.patch
Type: text/x-patch
Size: 1025 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20230309/98f06612/attachment.bin>