diff options
| author | Andrew Kaster <andrewdkaster@gmail.com> | 2021-05-23 15:33:52 -0600 |
|---|---|---|
| committer | Andreas Kling <kling@serenityos.org> | 2021-05-27 10:21:30 +0200 |
| commit | 2ec302ea22157c2be037430a5c27f82f19b4efd9 (patch) | |
| tree | d560e4190604dce4dfff9e701f7d7ce47d65dc8c /Documentation | |
| parent | dda8afcb9032b852b612971df2c116f916971c66 (diff) | |
| download | serenity-2ec302ea22157c2be037430a5c27f82f19b4efd9.zip | |
Meta/CI: Add ENABLE_ALL_DEBUG_FACILITIES CMake option
This option replaces the use of ENABLE_ALL_THE_DEBUG_MACROS in CI runs,
and enables all debug options that might be broken by developers
unintentionally that are only used in specific debugging situations.
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/BuildInstructions.md | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/Documentation/BuildInstructions.md b/Documentation/BuildInstructions.md index 5a132b99f1..ed89a9c131 100644 --- a/Documentation/BuildInstructions.md +++ b/Documentation/BuildInstructions.md @@ -248,6 +248,7 @@ There are some optional features that can be enabled during compilation that are - `ENABLE_FUZZER_SANITIZER`: builds [fuzzers](https://en.wikipedia.org/wiki/Fuzzing) for various parts of the system. - `ENABLE_EXTRA_KERNEL_DEBUG_SYMBOLS`: sets -Og and -ggdb3 compile options for building the Kernel. Allows for easier debugging of Kernel code. By default, the Kernel is built with -Os instead. - `ENABLE_ALL_THE_DEBUG_MACROS`: used for checking whether debug code compiles on CI. This should not be set normally, as it clutters the console output and makes the system run very slowly. Instead, enable only the needed debug macros, as described below. +- `ENABLE_ALL_DEBUG_FACILITIES`: used for checking whether debug code compiles on CI. Enables both `ENABLE_ALL_THE_DEBUG_MACROS` and `ENABLE_EXTRA_KERNEL_DEBUG_SYMBOLS`. - `ENABLE_COMPILETIME_FORMAT_CHECK`: checks for the validity of `std::format`-style format string during compilation. Enabled by default. - `ENABLE_PCI_IDS_DOWNLOAD`: downloads the [`pci.ids` database](https://pci-ids.ucw.cz/) that contains information about PCI devices at build time, if not already present. Enabled by default. - `BUILD_LAGOM`: builds [Lagom](../Meta/Lagom/ReadMe.md), which makes various SerenityOS libraries and programs available on the host system. |