Document `LLVM_USE_SPLIT_DWARF` option
authorChris Bieneman <chris.bieneman@me.com>
Mon, 25 Oct 2021 13:14:46 +0000 (18:44 +0530)
committerShivam Gupta <shivam98.tkg@gmail.com>
Mon, 25 Oct 2021 13:20:55 +0000 (18:50 +0530)
This patch adds a documentation note about the LLVM_USE_SPLIT_DWARF
CMake option which is useful to reduce linker memory usage.

llvm/docs/CMake.rst

index 08f6815..658484f 100644 (file)
@@ -729,6 +729,12 @@ enabled sub-projects. Nearly all of these variable names begin with
   are ``Address``, ``Memory``, ``MemoryWithOrigins``, ``Undefined``, ``Thread``,
   ``DataFlow``, and ``Address;Undefined``. Defaults to empty string.
 
+**LLVM_USE_SPLIT_DWARF**:BOOL
+  If enabled CMake will pass ``-gsplit-dwarf`` to the compiler. This option
+  reduces link-time memory usage by reducing the amount of debug information that
+  the linker needs to resolve. It is recommended for platforms using the ELF object
+  format, like Linux systems when linker memory usage is too high.
+
 **SPHINX_EXECUTABLE**:STRING
   The path to the ``sphinx-build`` executable detected by CMake.
   For installation instructions, see