[libcxx-commits] [libcxx] [libc++][NFC] Remove the list of `nodiscard` extensions from the docs. (PR #69546)
via libcxx-commits
libcxx-commits at lists.llvm.org
Wed Oct 18 18:02:23 PDT 2023
llvmbot wrote:
<!--LLVM PR SUMMARY COMMENT-->
@llvm/pr-subscribers-libcxx
Author: Konstantin Varlamov (var-const)
<details>
<summary>Changes</summary>
This list is a burden to maintain and provides very limited value. A user wishing to know whether a particular function is declared with a `nodiscard` extension would be better off grepping the headers.
---
Full diff: https://github.com/llvm/llvm-project/pull/69546.diff
1 Files Affected:
- (modified) libcxx/docs/UsingLibcxx.rst (+2-136)
``````````diff
diff --git a/libcxx/docs/UsingLibcxx.rst b/libcxx/docs/UsingLibcxx.rst
index 4d7d70e1d7901d4..52c76f3b10548fb 100644
--- a/libcxx/docs/UsingLibcxx.rst
+++ b/libcxx/docs/UsingLibcxx.rst
@@ -361,142 +361,8 @@ The extended applications of ``[[nodiscard]]`` takes two forms:
standard in newer dialects, but not in the present one.
2. Extended applications of ``[[nodiscard]]``, at the library's discretion,
- applied to entities never declared as such by the standard.
-
-Entities declared with ``_LIBCPP_NODISCARD_EXT``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-This section lists all extended applications of ``[[nodiscard]]`` to entities
-which no dialect declares as such (See the second form described above).
-
-* ``adjacent_find``
-* ``all_of``
-* ``any_of``
-* ``as_const``
-* ``binary_search``
-* ``bit_cast``
-* ``bit_ceil``
-* ``bit_floor``
-* ``bit_width``
-* ``byteswap``
-* ``cbrt``
-* ``ceil``
-* ``chrono::tzdb_list::begin``
-* ``chrono::tzdb_list::cbegin``
-* ``chrono::tzdb_list::cend``
-* ``chrono::tzdb_list::end``
-* ``chrono::get_tzdb_list``
-* ``chrono::get_tzdb``
-* ``chrono::remote_version``
-* ``clamp``
-* ``copysign``
-* ``count_if``
-* ``count``
-* ``countl_zero``
-* ``countl_one``
-* ``countr_zero``
-* ``countr_one``
-* ``equal_range``
-* ``equal``
-* ``fabs``
-* ``find_end``
-* ``find_first_of``
-* ``find_if_not``
-* ``find_if``
-* ``find``
-* ``floor``
-* ``fmax``
-* ``fmin``
-* ``forward``
-* ``fpclassify``
-* ``get_temporary_buffer``
-* ``has_single_bit``
-* ``identity::operator()``
-* ``includes``
-* ``is_heap_until``
-* ``is_heap``
-* ``is_partitioned``
-* ``is_permutation``
-* ``is_sorted_until``
-* ``is_sorted``
-* ``isfinite``
-* ``isgreater``
-* ``isgreaterequal``
-* ``isinf``
-* ``isless``
-* ``islessequal``
-* ``islessgreater``
-* ``isnan``
-* ``isnormal``
-* ``isunordered``
-* ``lexicographical_compare``
-* ``lock_guard``'s constructors
-* ``lower_bound``
-* ``make_format_args``
-* ``make_wformat_args``
-* ``max_element``
-* ``max``
-* ``min_element``
-* ``min``
-* ``minmax_element``
-* ``minmax``
-* ``mismatch``
-* ``move_if_noexcept``
-* ``move``
-* ``nearbyint``
-* ``none_of``
-* ``popcount``
-* ``ranges::adjacent_find``
-* ``ranges::all_of``
-* ``ranges::any_of``
-* ``ranges::binary_search``
-* ``ranges::clamp``
-* ``ranges::count_if``
-* ``ranges::count``
-* ``ranges::equal_range``
-* ``ranges::equal``
-* ``ranges::find_end``
-* ``ranges::find_first_of``
-* ``ranges::find_if_not``
-* ``ranges::find_if``
-* ``ranges::find``
-* ``ranges::get_temporary_buffer``
-* ``ranges::includes``
-* ``ranges::is_heap_until``
-* ``ranges::is_heap``
-* ``ranges::is_partitioned``
-* ``ranges::is_permutation``
-* ``ranges::is_sorted_until``
-* ``ranges::is_sorted``
-* ``ranges::lexicographical_compare``
-* ``ranges::lower_bound``
-* ``ranges::max_element``
-* ``ranges::max``
-* ``ranges::min_element``
-* ``ranges::min``
-* ``ranges::minmax_element``
-* ``ranges::minmax``
-* ``ranges::mismatch``
-* ``ranges::none_of``
-* ``ranges::remove_if``
-* ``ranges::remove``
-* ``ranges::search_n``
-* ``ranges::search``
-* ``ranges::unique``
-* ``ranges::upper_bound``
-* ``remove_if``
-* ``remove``
-* ``rint``
-* ``round``
-* ``search_n``
-* ``search``
-* ``signbit``
-* ``to_integer``
-* ``to_underlying``
-* ``trunc``
-* ``unique``
-* ``upper_bound``
-* ``vformat``
+ applied to entities never declared as such by the standard. You can find
+ all such applications by grepping for ``_LIBCPP_NODISCARD_EXT``.
Extended integral type support
------------------------------
``````````
</details>
https://github.com/llvm/llvm-project/pull/69546
More information about the libcxx-commits
mailing list