Skip to content

Commit 1777c20

Browse files
committed
fix version-related inconsistencies in CMake and docs
1 parent 4e37124 commit 1777c20

4 files changed

Lines changed: 9 additions & 8 deletions

File tree

‎CMakeLists.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
cmake_minimum_required(VERSION 3.13)
1+
cmake_minimum_required(VERSION 3.24)
22

33
# Version is defined once in the version header.
44
set(UBLKCPP_VERSION_HEADER include/ublk/version.hpp)

‎docs/Doxyfile.in‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ PROJECT_NUMBER = @UBLKCPP_VERSION_STRING@
5454
# for a project that appears at the top of each page and should give viewers a
5555
# quick idea about the purpose of the project. Keep the description short.
5656

57-
PROJECT_BRIEF = A ublk library targeting C++26 std::execution.
57+
PROJECT_BRIEF = A ublk library for std::execution.
5858

5959
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
6060
# in the documentation. The maximum height of the logo should not exceed 55

‎docs/build.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,6 @@ ublk-cpp provides CMake options to build tests, the `ublkctl` tool, examples, an
5555
| `UBLKCPP_BUILD_EXAMPLES` | Build examples | OFF |
5656
| `UBLKCPP_BUILD_DOCS` | Build Doxygen documentation | OFF |
5757
| `UBLKCPP_USE_URING_CMD128` | Use `IORING_OP_URING_CMD128` for control commands | ON |
58-
| `UBLKCPP_TESTS_STATIC_LINK` | Use static linking for tests | OFF |
59-
| `UBLKCPP_TESTS_ASAN` | Enable ASan/UBSan for tests | OFF |
6058

6159
```bash
6260
cmake -B build -S . \

‎docs/guide.md‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ ublk is a kernel framework for implementing block device drivers in userspace. I
99
The runtime is represented by `condy::Runtime`, and a scheduler object can be obtained via `condy::get_scheduler()`. All interfaces provided by ublk-cpp are required to run on that scheduler.
1010

1111
```cpp
12+
namespace ex = std::execution; // or stdexec / beman::execution
1213
// sqe128 is required for ublk control cmd
1314
condy::Runtime runtime(condy::RuntimeOptions().enable_sqe128());
1415
std::jthread loop([&]() { runtime.run(); });
@@ -180,15 +181,17 @@ Then run `ublk::daemon::run()` and `ublk::daemon::start()` concurrently. After `
180181
```cpp
181182
ex::task<void> wait_signal(int ctrl_fd, int signal_fd, uint32_t dev_id,
182183
ex::inplace_stop_source &source) {
183-
std::println("ublk-nop: ublk device {} is running...", dev_id);
184+
std::cout << std::format("ublk-nop: ublk device {} is running...", dev_id)
185+
<< '\n';
184186
auto parent_token = co_await ex::read_env(ex::get_stop_token);
185187
ex::inplace_stop_callback cb{parent_token,
186-
[&] noexcept { source.request_stop(); }};
188+
[&]() noexcept { source.request_stop(); }};
187189
signalfd_siginfo si;
188190
co_await (condy::async_read(signal_fd, condy::buffer(&si, sizeof(si)), 0) |
189191
ex::write_env(ex::prop{ex::get_stop_token, source.get_token()}));
190-
std::println("ublk-nop: received signal {}, shutting down...",
191-
si.ssi_signo);
192+
std::cout << std::format("ublk-nop: received signal {}, shutting down...",
193+
si.ssi_signo)
194+
<< '\n';
192195
co_await ublk::stop_dev(ctrl_fd, dev_id);
193196
}
194197
// ...

0 commit comments

Comments
 (0)