summaryrefslogtreecommitdiff
path: root/libcxx/docs
diff options
context:
space:
mode:
authorLouis Dionne <ldionne@apple.com>2018-11-16 14:57:47 +0000
committerLouis Dionne <ldionne@apple.com>2018-11-16 14:57:47 +0000
commit6881f9126fcfe0a270bfe711f73ebf41a7d12a79 (patch)
treeb606ba342244a9f3be4c782315b76db10abd1ed6 /libcxx/docs
parentb28c609e9e63489bbe32075e693d865de16dc6f0 (diff)
[libcxx] Mention restriction on inline namespaces in LIBCXX_ABI_NAMESPACE docs
I also kept the original "vague" documentation that saying that users are responsible for not breaking us. This doesn't mean anything because there's no way they can actually enforce that unless we restrict ourselves to a specific naming scheme, but I left the documentation because it acts as a good warning and gives us more leeway.
Diffstat (limited to 'libcxx/docs')
-rw-r--r--libcxx/docs/BuildingLibcxx.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/libcxx/docs/BuildingLibcxx.rst b/libcxx/docs/BuildingLibcxx.rst
index 12acd0bbd2f..c40e5fbcc75 100644
--- a/libcxx/docs/BuildingLibcxx.rst
+++ b/libcxx/docs/BuildingLibcxx.rst
@@ -379,7 +379,9 @@ The following options allow building libc++ for a different ABI version.
.. warning::
When providing a custom namespace, it's the users responsibility to ensure the name won't cause
- conflicts with other names defined by libc++, both now and in the future.
+ conflicts with other names defined by libc++, both now and in the future. In particular, inline
+ namespaces of the form ``__[0-9]+`` are strictly reserved by libc++ and may not be used by users.
+ Doing otherwise could cause conflicts and hinder libc++ ABI evolution.
.. option:: LIBCXX_ABI_DEFINES:STRING