Skip to content

[libc++] [NFC] Documentation: Add _LIBCPP_PUSH_MACROS and _LIBCPP_POP_MACROS #79963

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

H-G-Hristov
Copy link
Contributor

I got tripped twice after: 7b46225 Let's at least mention these in the Contributing.rst doc.

…POP_MACROS`

I got tripped twice after: 7b46225 Let's at least mention these in the `Contributing.rst` doc.
@H-G-Hristov H-G-Hristov requested a review from a team as a code owner January 30, 2024 08:19
@llvmbot llvmbot added the libc++ libc++ C++ Standard Library. Not GNU libstdc++. Not libc++abi. label Jan 30, 2024
@llvmbot
Copy link
Member

llvmbot commented Jan 30, 2024

@llvm/pr-subscribers-libcxx

Author: Hristo Hristov (H-G-Hristov)

Changes

I got tripped twice after: 7b46225 Let's at least mention these in the Contributing.rst doc.


Full diff: https://github.com/llvm/llvm-project/pull/79963.diff

1 Files Affected:

  • (modified) libcxx/docs/Contributing.rst (+1)
diff --git a/libcxx/docs/Contributing.rst b/libcxx/docs/Contributing.rst
index 3ff8c15a969b0..596d86ef22449 100644
--- a/libcxx/docs/Contributing.rst
+++ b/libcxx/docs/Contributing.rst
@@ -162,6 +162,7 @@ sure you don't forget anything:
 
 - Did you add the relevant feature test macro(s) for your feature? Did you update the ``generate_feature_test_macro_components.py`` script with it?
 - Did you run the ``libcxx-generate-files`` target and verify its output?
+- If needed, did you add `_LIBCPP_PUSH_MACROS` and `_LIBCPP_POP_MACROS` to the relevant headers?
 
 The review process
 ==================

@Zingam Zingam requested review from ldionne and removed request for a team January 30, 2024 08:21
Copy link
Contributor Author

@H-G-Hristov H-G-Hristov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ldionne I don't think that these macros are documented and it can be confusing when the CI starts poping up cryptic error messages. I think they should be documented. I only realized what was the issue after seeing this commit: 7b46225

Copy link
Member

@ldionne ldionne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This makes sense to me. It's really unfortunate that we even need this, but oh well.

@ldionne ldionne merged commit 21d75ee into llvm:main Jan 30, 2024
@H-G-Hristov H-G-Hristov deleted the hgh/libcxx/Update-documentation-Contributing branch January 31, 2024 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
libc++ libc++ C++ Standard Library. Not GNU libstdc++. Not libc++abi.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants