[libcxx-commits] [libcxx] 1855333 - [libc++] Fix documentation for setting hardening ABI macros (#121946)

[via libcxx-commits]

Author: Louis Dionne
Date: 2025-01-07T16:47:39-05:00
New Revision: 1855333e3a843174c0d7421d4c5e404649f6b75a

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

LOG: [libc++] Fix documentation for setting hardening ABI macros (#121946)

The documentation was misleading, suggesting that people could simply
define these macros, when in reality they must be passed at CMake
configuration time in a very specific way.

This was reported in #https://github.com/bitcoin/bitcoin/pull/31612.

Added: 
    

Modified: 
    libcxx/docs/Hardening.rst

Removed: 
    


################################################################################
diff  --git a/libcxx/docs/Hardening.rst b/libcxx/docs/Hardening.rst
index 73d59c05914fd5..d399b94d27c197 100644
--- a/libcxx/docs/Hardening.rst
+++ b/libcxx/docs/Hardening.rst
@@ -311,7 +311,10 @@ ABI configuration.
 ABI options
 -----------
 
-Vendors can use the following ABI options to enable additional hardening checks:
+Vendors can use some ABI options at CMake configuration time (when building libc++
+itself) to enable additional hardening checks. This is done by passing these
+macros as ``-DLIBCXX_ABI_DEFINES="_LIBCPP_ABI_FOO;_LIBCPP_ABI_BAR;etc"`` at
+CMake configuration time. The available options are:
 
 - ``_LIBCPP_ABI_BOUNDED_ITERATORS`` -- changes the iterator type of select
   containers (see below) to a bounded iterator that keeps track of whether it's