[PATCH] D111746: Fix LLVM_EXTERNALIZE_DEBUGINFO docs, and add new options from patchset

[Jo Shields via Phabricator via llvm-commits]

directhex created this revision.
Herald added a subscriber: mgorny.
directhex requested review of this revision.
Herald added a project: LLVM.
Herald added a subscriber: llvm-commits.

This fixes the "Mac only" comment in the documentation, and adds the new options added in my related patches


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D111746

Files:
  llvm-project/llvm/docs/CMake.rst


Index: llvm-project/llvm/docs/CMake.rst
===================================================================
--- llvm-project/llvm/docs/CMake.rst
+++ llvm-project/llvm/docs/CMake.rst
@@ -556,9 +556,30 @@
   -DLLVM_EXTERNAL_BAR_SOURCE_DIR=/src/bar``.

 **LLVM_EXTERNALIZE_DEBUGINFO**:BOOL
-  Generate dSYM files and strip executables and libraries (Darwin Only).
+  Generate dSYM files and strip executables and libraries. On Windows, debug
+  info (pdb files) is always external, and always produced on Debug or
+  RelWithDebInfo builds, or Release builds with LLVM_ENABLE_PDB.
   Defaults to OFF.

+**LLVM_EXTERNALIZE_DEBUGINFO_EXTENSION**:STRING
+  Specify the file extension used by LLVM_EXTERNALIZE_DEBUGINFO. Defaults to
+  .debug on Linux, and .dSYM on macOS unless LLVM_EXTERNALIZE_DEBUGINFO_FLATTEN
+  is enabled, which defaults to .dwarf.
+
+**LLVM_EXTERNALIZE_DEBUGINFO_FLATTEN**:BOOL
+  Tell dsymutil to emit a simple "flat" debug file, rather than a full debug
+  directory structure. macOS only.
+  Defaults to OFF.
+
+**LLVM_EXTERNALIZE_DEBUGINFO_INSTALL**:BOOL
+  Install debug symbols alongside executables, during call to cmake install.
+  Also enables installing .pdb files on Windows.
+  Defaults to OFF.
+
+**LLVM_EXTERNALIZE_DEBUGINFO_OUTPUT_DIR**:STRING
+  Override the directory where debug symbols are produced. Defaults to no value
+  (place debug symbols next to their corresponding executables)
+
 **LLVM_FORCE_USE_OLD_TOOLCHAIN**:BOOL
   If enabled, the compiler and standard library versions won't be checked. LLVM
   may not compile at all, or might fail at runtime due to known bugs in these


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D111746.379459.patch
Type: text/x-patch
Size: 1622 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20211013/9b67b1a7/attachment.bin>