aboutsummaryrefslogtreecommitdiff
path: root/embassy-time-queue-driver
diff options
context:
space:
mode:
Diffstat (limited to 'embassy-time-queue-driver')
-rw-r--r--embassy-time-queue-driver/Cargo.toml2
-rw-r--r--embassy-time-queue-driver/src/lib.rs3
2 files changed, 2 insertions, 3 deletions
diff --git a/embassy-time-queue-driver/Cargo.toml b/embassy-time-queue-driver/Cargo.toml
index a104f5c39..7fa91bb0c 100644
--- a/embassy-time-queue-driver/Cargo.toml
+++ b/embassy-time-queue-driver/Cargo.toml
@@ -36,7 +36,7 @@ embassy-executor = { version = "0.6.3", path = "../embassy-executor" }
36#! The features also set how many timers are used for the generic queue. At most one 36#! The features also set how many timers are used for the generic queue. At most one
37#! `generic-queue-*` feature can be enabled. If none is enabled, a default of 64 timers is used. 37#! `generic-queue-*` feature can be enabled. If none is enabled, a default of 64 timers is used.
38#! 38#!
39#! When using embassy-time from libraries, you should *not* enable any `generic-queue-*` feature, to allow the 39#! When using embassy-time-queue-driver from libraries, you should *not* enable any `generic-queue-*` feature, to allow the
40#! end user to pick. 40#! end user to pick.
41 41
42## Generic Queue with 8 timers 42## Generic Queue with 8 timers
diff --git a/embassy-time-queue-driver/src/lib.rs b/embassy-time-queue-driver/src/lib.rs
index 333b6124d..72453f0ea 100644
--- a/embassy-time-queue-driver/src/lib.rs
+++ b/embassy-time-queue-driver/src/lib.rs
@@ -4,8 +4,7 @@
4 4
5//! This crate is an implementation detail of `embassy-time-driver`. 5//! This crate is an implementation detail of `embassy-time-driver`.
6//! 6//!
7//! As a HAL user, you should only depend on this crate if your application does not use 7//! As a HAL user, you should not need to depend on this crate directly.
8//! `embassy-executor` and your HAL does not configure a generic queue by itself.
9//! 8//!
10//! As a HAL implementer, you need to depend on this crate if you want to implement a time driver, 9//! As a HAL implementer, you need to depend on this crate if you want to implement a time driver,
11//! but how you should do so is documented in `embassy-time-driver`. 10//! but how you should do so is documented in `embassy-time-driver`.