[libcxx-commits] [libcxx] 473a160 - [libc++][NFC] Fix some standard-mandated includes comments

Nikolas Klauser via libcxx-commits libcxx-commits at lists.llvm.org
Tue Sep 27 12:12:04 PDT 2022 

Author: Nikolas Klauser
Date: 2022-09-27T21:11:53+02:00
New Revision: 473a1605063421a36b82b31dc5a7e9533d6e229e

URL: https://github.com/llvm/llvm-project/commit/473a1605063421a36b82b31dc5a7e9533d6e229e
DIFF: https://github.com/llvm/llvm-project/commit/473a1605063421a36b82b31dc5a7e9533d6e229e.diff

LOG: [libc++][NFC] Fix some standard-mandated includes comments

Reviewed By: ldionne, #libc

Spies: libcxx-commits

Differential Revision: https://reviews.llvm.org/D134447

Added: 
    

Modified: 
    libcxx/include/algorithm
    libcxx/include/bitset
    libcxx/include/chrono
    libcxx/include/cinttypes
    libcxx/include/coroutine
    libcxx/include/filesystem
    libcxx/include/ios
    libcxx/include/iostream
    libcxx/include/iterator
    libcxx/include/memory
    libcxx/include/optional
    libcxx/include/queue
    libcxx/include/random
    libcxx/include/stack
    libcxx/include/system_error
    libcxx/include/thread
    libcxx/include/tuple
    libcxx/include/valarray
    libcxx/include/variant

Removed: 
    


################################################################################
diff  --git a/libcxx/include/algorithm b/libcxx/include/algorithm
index 0552e661a9b0..9b21e7bbf193 100644
--- a/libcxx/include/algorithm
+++ b/libcxx/include/algorithm
@@ -1899,6 +1899,8 @@ template <class BidirectionalIterator, class Compare>
 #include <__algorithm/upper_bound.h>
 
 // standard-mandated includes
+
+// [algorithm.syn]
 #include <initializer_list>
 
 #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)

diff  --git a/libcxx/include/bitset b/libcxx/include/bitset
index 0c56436040fd..72b678b5ffdd 100644
--- a/libcxx/include/bitset
+++ b/libcxx/include/bitset
@@ -125,6 +125,8 @@ template <size_t N> struct hash<std::bitset<N>>;
 #include <version>
 
 // standard-mandated includes
+
+// [bitset.syn]
 #include <iosfwd>
 #include <string>
 

diff  --git a/libcxx/include/chrono b/libcxx/include/chrono
index dcdefd7d44dd..ce7c621e25e6 100644
--- a/libcxx/include/chrono
+++ b/libcxx/include/chrono
@@ -694,6 +694,8 @@ constexpr chrono::year                                  operator ""y(unsigned lo
 #include <version>
 
 // standard-mandated includes
+
+// [time.syn]
 #include <compare>
 
 #if !defined(_LIBCPP_HAS_NO_LOCALIZATION) && !defined(_LIBCPP_HAS_NO_INCOMPLETE_FORMAT) && _LIBCPP_STD_VER > 17

diff  --git a/libcxx/include/cinttypes b/libcxx/include/cinttypes
index 09304460986a..a5b9558abde1 100644
--- a/libcxx/include/cinttypes
+++ b/libcxx/include/cinttypes
@@ -236,6 +236,10 @@ uintmax_t wcstoumax(const wchar_t* restrict nptr, wchar_t** restrict endptr, int
 
 #include <__assert> // all public C++ headers provide the assertion handler
 #include <__config>
+
+// standard-mandated includes
+
+// [cinttypes.syn]
 #include <cstdint>
 
 #include <inttypes.h>

diff  --git a/libcxx/include/coroutine b/libcxx/include/coroutine
index a81d68f39480..e0ce32384368 100644
--- a/libcxx/include/coroutine
+++ b/libcxx/include/coroutine
@@ -47,6 +47,8 @@ struct suspend_always;
 #include <version>
 
 // standard-mandated includes
+
+// [coroutine.syn]
 #include <compare>
 
 #ifndef _LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER

diff  --git a/libcxx/include/filesystem b/libcxx/include/filesystem
index 086d59764f48..1e7efd248aa1 100644
--- a/libcxx/include/filesystem
+++ b/libcxx/include/filesystem
@@ -449,6 +449,8 @@ inline constexpr bool std::ranges::enable_view<std::filesystem::recursive_direct
 #include <version>
 
 // standard-mandated includes
+
+// [fs.filesystem.syn]
 #include <compare>
 
 #if defined(_LIBCPP_HAS_NO_FILESYSTEM_LIBRARY)

diff  --git a/libcxx/include/ios b/libcxx/include/ios
index 2f9efcc3c772..6e8360f4ab56 100644
--- a/libcxx/include/ios
+++ b/libcxx/include/ios
@@ -224,6 +224,8 @@ storage-class-specifier const error_category& iostream_category() noexcept;
 #include <version>
 
 // standard-mandated includes
+
+// [ios.syn]
 #include <iosfwd>
 
 #if !defined(_LIBCPP_HAS_NO_ATOMIC_HEADER)

diff  --git a/libcxx/include/iostream b/libcxx/include/iostream
index 13d4ac3cadae..d679d9932d7e 100644
--- a/libcxx/include/iostream
+++ b/libcxx/include/iostream
@@ -38,6 +38,8 @@ extern wostream wclog;
 #include <version>
 
 // standard-mandated includes
+
+// [iostream.syn]
 #include <ios>
 #include <istream>
 #include <ostream>

diff  --git a/libcxx/include/iterator b/libcxx/include/iterator
index be544b8b3ee6..679b3da31724 100644
--- a/libcxx/include/iterator
+++ b/libcxx/include/iterator
@@ -717,13 +717,17 @@ template <class E> constexpr const E* data(initializer_list<E> il) noexcept;
 #include <__iterator/wrap_iter.h>
 #include <__memory/addressof.h>
 #include <__memory/pointer_traits.h>
-#include <compare>
-#include <concepts> // Mandated by the Standard.
 #include <cstddef>
 #include <initializer_list>
 #include <type_traits>
 #include <version>
 
+// standard-mandated includes
+
+// [iterator.synopsis]
+#include <compare>
+#include <concepts>
+
 #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
 #  pragma GCC system_header
 #endif

diff  --git a/libcxx/include/memory b/libcxx/include/memory
index 4d29b7103ba6..5975383aa26f 100644
--- a/libcxx/include/memory
+++ b/libcxx/include/memory
@@ -886,6 +886,8 @@ template<size_t N, class T>
 #include <version>
 
 // standard-mandated includes
+
+// [memory.syn]
 #include <compare>
 
 #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)

diff  --git a/libcxx/include/optional b/libcxx/include/optional
index 7dc543bd8129..1061a0f9c378 100644
--- a/libcxx/include/optional
+++ b/libcxx/include/optional
@@ -178,6 +178,8 @@ template<class T>
 #include <version>
 
 // standard-mandated includes
+
+// [optional.syn]
 #include <compare>
 
 #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)

diff  --git a/libcxx/include/queue b/libcxx/include/queue
index f36ccfdeedb3..d23f2385eda3 100644
--- a/libcxx/include/queue
+++ b/libcxx/include/queue
@@ -232,6 +232,8 @@ template <class T, class Container, class Compare>
 #include <version>
 
 // standard-mandated includes
+
+// [queue.syn]
 #include <compare>
 #include <initializer_list>
 

diff  --git a/libcxx/include/random b/libcxx/include/random
index ebb97a47050e..ecab84a57355 100644
--- a/libcxx/include/random
+++ b/libcxx/include/random
@@ -1719,6 +1719,8 @@ class piecewise_linear_distribution
 #include <version>
 
 // standard-mandated includes
+
+// [rand.synopsis]
 #include <initializer_list>
 
 #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)

diff  --git a/libcxx/include/stack b/libcxx/include/stack
index 8f0a997156d6..7b08d57da152 100644
--- a/libcxx/include/stack
+++ b/libcxx/include/stack
@@ -108,6 +108,8 @@ template <class T, class Container>
 #include <version>
 
 // standard-mandated includes
+
+// [stack.syn]
 #include <compare>
 #include <initializer_list>
 

diff  --git a/libcxx/include/system_error b/libcxx/include/system_error
index ce6785aef036..f81165fb8b41 100644
--- a/libcxx/include/system_error
+++ b/libcxx/include/system_error
@@ -156,6 +156,8 @@ template <> struct hash<std::error_condition>;
 #include <version>
 
 // standard-mandated includes
+
+// [system.error.syn]
 #include <compare>
 
 #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)

diff  --git a/libcxx/include/thread b/libcxx/include/thread
index 136411d82bea..7c6d4f8828c0 100644
--- a/libcxx/include/thread
+++ b/libcxx/include/thread
@@ -100,6 +100,8 @@ void sleep_for(const chrono::duration<Rep, Period>& rel_time);
 #include <version>
 
 // standard-mandated includes
+
+// [thread.syn]
 #include <compare>
 
 #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)

diff  --git a/libcxx/include/tuple b/libcxx/include/tuple
index 038d53c5b71e..a14d90365959 100644
--- a/libcxx/include/tuple
+++ b/libcxx/include/tuple
@@ -221,6 +221,8 @@ template <class... Types>
 #include <version>
 
 // standard-mandated includes
+
+// [tuple.syn]
 #include <compare>
 
 #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)

diff  --git a/libcxx/include/valarray b/libcxx/include/valarray
index e0f07537d3e3..f28e471dfb3f 100644
--- a/libcxx/include/valarray
+++ b/libcxx/include/valarray
@@ -361,6 +361,8 @@ template <class T> unspecified2 end(const valarray<T>& v);
 #include <version>
 
 // standard-mandated includes
+
+// [valarray.syn]
 #include <initializer_list>
 
 #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)

diff  --git a/libcxx/include/variant b/libcxx/include/variant
index 7e2bea3ae7a9..147dadfde90f 100644
--- a/libcxx/include/variant
+++ b/libcxx/include/variant
@@ -228,6 +228,8 @@ namespace std {
 #include <version>
 
 // standard-mandated includes
+
+// [variant.syn]
 #include <compare>
 
 #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)

More information about the libcxx-commits mailing list