Skip to content

Commit bc87636

Browse files
martinlichtldionne
andauthored
Update libcxx/docs/UserDocumentation.rst
Co-authored-by: Louis Dionne <[email protected]>
1 parent 2c9f0a9 commit bc87636

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

libcxx/docs/UserDocumentation.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,10 +142,14 @@ enable or disable extended libc++ behavior.
142142
to internal dependencies. The common practice is to have the standard headers
143143
internally include other standard headers, but this generally results in
144144
increased compilation overhead. This configuration option attempts to mitigate
145-
this problem by avoiding such unnecessary inclusions. In addition, compiling
146-
a codebase with this macro may improve maintainability by identifying
145+
this problem by avoiding such unnecessary inclusions. Compiling
146+
a codebase with this macro may improve portability by identifying
147147
missing standard header inclusions.
148148

149+
However, be aware that enabling this macro may lead to breakages
150+
when updating to a newer version of the library, since transitive includes
151+
that your code was previously relying on may have been removed.
152+
149153
**_LIBCPP_DISABLE_DEPRECATION_WARNINGS**:
150154
This macro disables warnings when using deprecated components. For example,
151155
using `std::auto_ptr` when compiling in C++11 mode will normally trigger a

0 commit comments

Comments
 (0)