Skip to content

[cmake] Document and suggest LLVM_ENABLE_PDB #102887

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 13, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions llvm/docs/CMake.rst
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,11 @@ used variables that control features of LLVM and enabled subprojects.
If you are using an IDE such as Visual Studio or Xcode, you should use
the IDE settings to set the build type.

Note: on Windows (building with MSVC or clang-cl), CMake's **RelWithDebInfo**
setting does not enable the same optimizations as **Release**. Using the
**Release** build type with :ref:`LLVM_ENABLE_PDB <llvm_enable_pdb>` set
may be a better option.

**CMAKE_INSTALL_PREFIX**:PATH
Path where LLVM will be installed when the "install" target is built.

Expand Down Expand Up @@ -548,6 +553,12 @@ enabled sub-projects. Nearly all of these variable names begin with
Compile with `Clang Header Modules
<https://clang.llvm.org/docs/Modules.html>`_.

.. _llvm_enable_pdb:

**LLVM_ENABLE_PDB**:BOOL
For Windows builds using MSVC or clang-cl, generate PDB files when
:ref:`CMAKE_BUILD_TYPE <cmake_build_type>` is set to Release.

**LLVM_ENABLE_PEDANTIC**:BOOL
Enable pedantic mode. This disables compiler-specific extensions, if
possible. Defaults to ON.
Expand Down
Loading