[PATCH] D68556: Document `LLVM_USE_SPLIT_DWARF` option

[Chris Bieneman via Phabricator via llvm-commits]

beanz created this revision.
beanz added a reviewer: dblaikie.
Herald added subscribers: aprantl, mgorny.
Herald added a project: LLVM.

This patch adds a documentation note about the `LLVM_USE_SPLIT_DWARF` CMake option which is useful to reduce linker memory usage.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D68556

Files:
  llvm/docs/CMake.rst


Index: llvm/docs/CMake.rst
===================================================================
--- llvm/docs/CMake.rst
+++ llvm/docs/CMake.rst
@@ -619,6 +619,12 @@
   If enabled, the Z3 constraint solver is activated for the Clang static analyzer.
   A recent version of the z3 library needs to be available on the system.
 
+**LLVM_USE_SPLIT_DWARF**:BOOL
+  If enabled CMake will pass ``-gsplit-dwarf`` to the compiler. This option
+  reduces link-time meory usage by reducing the amount of debug information that
+  the linker needs to resolve. It is recommended for use on Linux systems when
+  linker memory usage is too high.
+
 CMake Caches
 ============
 


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D68556.223445.patch
Type: text/x-patch
Size: 663 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20191006/51ae3ee8/attachment.bin>