[llvm] docs/GettingStarted: document linker-related cmake options (PR #80932)

[Nicolai Hähnle via llvm-commits]

https://github.com/nhaehnle created https://github.com/llvm/llvm-project/pull/80932

Both LLVM_LINK_LLVM_DYLIB and LLVM_PARALLEL_LINK_JOBS help with some common gotchas. It seems worth documenting them here explicitly.

>From 8928a0e6757e2a7fcf4083f3cea83b7a07c81ead Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Nicolai=20H=C3=A4hnle?= <nicolai.haehnle at amd.com>
Date: Wed, 7 Feb 2024 01:35:53 +0100
Subject: [PATCH] docs/GettingStarted: document linker-related cmake options

Both LLVM_LINK_LLVM_DYLIB and LLVM_PARALLEL_LINK_JOBS help with some
common gotchas. It seems worth documenting them here explicitly.
---
 llvm/docs/GettingStarted.rst | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/llvm/docs/GettingStarted.rst b/llvm/docs/GettingStarted.rst
index 316fc6ad86b848..69475e7e922d1b 100644
--- a/llvm/docs/GettingStarted.rst
+++ b/llvm/docs/GettingStarted.rst
@@ -605,6 +605,13 @@ used by people developing LLVM.
 |                         | ``tools/llvm-shlib/CMakelists.txt``. This option is|
 |                         | not available on Windows.                          |
 +-------------------------+----------------------------------------------------+
+| LLVM_LINK_LLVM_DYLIB    | Link tools against libLLVM.so. This can save a     |
+|                         | significant amount of disk space.                  |
++-------------------------+----------------------------------------------------+
+| LLVM_PARALLEL_LINK_JOBS | Limit the number of parallel linking jobs during   |
+|                         | a parallel build. This can help prevent running    |
+|                         | out of memory  during build.                       |
++-------------------------+----------------------------------------------------+
 | LLVM_OPTIMIZED_TABLEGEN | Builds a release tablegen that gets used during    |
 |                         | the LLVM build. This can dramatically speed up     |
 |                         | debug builds.                                      |