Skip to content

Commit e87eb82

Browse files
committed
Clarify and deduplicate string comment
1 parent 109e940 commit e87eb82

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

libcxx/include/string

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -680,14 +680,12 @@ _LIBCPP_PUSH_MACROS
680680

681681
// Since std::string is partially instantiated in the built library, we require that the library
682682
// has been built with ASAN support in order to enable the container checks in std::string.
683+
// Within the <string> implementation, use `_LIBCPP_ENABLE_ASAN_CONTAINER_CHECKS_FOR_STRING`
684+
// to determine whether ASAN container checks should be provided.
683685
//
684-
// This also means that if the built library has been compiled with sanitizer checks enabled
685-
// and the user requests for the container checks to be disabled, that request will not be
686-
// honored.
687-
//
688-
// The _LIBCPP_STRING_INTERNAL_MEMORY_ACCESS macro disables AddressSanitizer (ASan) instrumentation
689-
// for a specific function, allowing memory accesses that would normally trigger ASan errors to proceed
690-
// without crashing. This is useful for accessing parts of objects memory, which should not be accessed,
686+
// The _LIBCPP_STRING_INTERNAL_MEMORY_ACCESS macro disables ASAN instrumentation for a specific
687+
// function, allowing memory accesses that would normally trigger ASan errors to proceed without
688+
// crashing. This is useful for accessing parts of objects memory, which should not be accessed,
691689
// such as unused bytes in short strings, that should never be accessed by other parts of the program.
692690
# if _LIBCPP_ENABLE_ASAN_CONTAINER_CHECKS && _LIBCPP_INSTRUMENTED_WITH_ASAN
693691
# define _LIBCPP_ENABLE_ASAN_CONTAINER_CHECKS_FOR_STRING 1

0 commit comments

Comments
 (0)