[llvm] b2544fb - Document `LLVM_USE_SPLIT_DWARF` option

[Shivam Gupta via llvm-commits]

Author: Chris Bieneman
Date: 2021-10-25T18:50:55+05:30
New Revision: b2544fb9c5b38339572d50048563e8b6e72bf0ad

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

LOG: Document `LLVM_USE_SPLIT_DWARF` option

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

Added: 
    

Modified: 
    llvm/docs/CMake.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/CMake.rst b/llvm/docs/CMake.rst
index 08f6815171160..658484f7fd5c6 100644
--- a/llvm/docs/CMake.rst
+++ b/llvm/docs/CMake.rst
@@ -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