Skip to content

Commit 1855333

Browse files
authored
[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 #bitcoin/bitcoin#31612.
1 parent 9612175 commit 1855333

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

libcxx/docs/Hardening.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,10 @@ ABI configuration.
311311
ABI options
312312
-----------
313313

314-
Vendors can use the following ABI options to enable additional hardening checks:
314+
Vendors can use some ABI options at CMake configuration time (when building libc++
315+
itself) to enable additional hardening checks. This is done by passing these
316+
macros as ``-DLIBCXX_ABI_DEFINES="_LIBCPP_ABI_FOO;_LIBCPP_ABI_BAR;etc"`` at
317+
CMake configuration time. The available options are:
315318

316319
- ``_LIBCPP_ABI_BOUNDED_ITERATORS`` -- changes the iterator type of select
317320
containers (see below) to a bounded iterator that keeps track of whether it's

0 commit comments

Comments
 (0)