Skip to content

Commit 3e27e9c

Browse files
Doc updates, notes on CMake version compatibility
1 parent 23c880f commit 3e27e9c

File tree

3 files changed

+7
-3
lines changed

3 files changed

+7
-3
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,3 +73,7 @@ test/wait_queue_test -s
7373

7474
The example can be built by adding `-D WAIT_QUEUE_BUILD_EXAMPLES:BOOL=ON` to the CMake configure / generate step.
7575

76+
### CMake Version Compatibility
77+
78+
CMake 3.27 and later has removed (or will remove) compatibility with CMake versions older than 3.5. The GitHub actions for the `wait_queue` unit test have been updated to use the `CMAKE_POLICY_VERSION_MINIMUM=3.5` flag as a workaround (until the dependent library CMake files have been updated appropriately).
79+

include/queue/wait_queue.hpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* for specific use cases (see below for additional details). The default container
1515
* type is @c std::deque.
1616
*
17-
* A graceful shutdown can be requested using the @c request_stop method (modeled on the
17+
* A graceful shutdown can be requested using the @c std::request_stop method (modeled on the
1818
* C++ 20 @c request_stop from @c std::stop_source). This allows waiting reader threads
1919
* to be notified for shutdown. Alternatively a @c std::stop_token can be passed in to
2020
* the @c wait_queue constructor, allowing shutdown from outside of the @c wait_queue
@@ -142,7 +142,7 @@
142142
*
143143
* @authors Cliff Green, Lou Langholtz, Anthony Williams
144144
*
145-
* @copyright (c) 2017-2024 by Cliff Green
145+
* @copyright (c) 2017-2025 by Cliff Green
146146
*
147147
* Distributed under the Boost Software License, Version 1.0.
148148
* (See accompanying file LICENSE.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

test/wait_queue_test.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*
55
* @author Cliff Green
66
*
7-
* @copyright (c) 2017-2024 by Cliff Green
7+
* @copyright (c) 2017-2025 by Cliff Green
88
*
99
* Distributed under the Boost Software License, Version 1.0.
1010
* (See accompanying file LICENSE.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

0 commit comments

Comments
 (0)