From 0492dba5368e7cb22ede2d41d26d4d0431ba2252 Mon Sep 17 00:00:00 2001
From: Dániel Buga <bugadani@gmail.com>
Date: Sun, 15 Dec 2024 19:24:49 +0100
Subject: Update documentation and changelogs

---
 embassy-time-queue-driver/src/lib.rs | 49 ++++--------------------------------
 1 file changed, 5 insertions(+), 44 deletions(-)

(limited to 'embassy-time-queue-driver/src')

diff --git a/embassy-time-queue-driver/src/lib.rs b/embassy-time-queue-driver/src/lib.rs
index 46dd646ca..d8b01df3b 100644
--- a/embassy-time-queue-driver/src/lib.rs
+++ b/embassy-time-queue-driver/src/lib.rs
@@ -2,52 +2,13 @@
 #![doc = include_str!("../README.md")]
 #![warn(missing_docs)]
 
-//! ## Implementing a timer queue
+//! This crate is an implementation detail of `embassy-time-driver`.
 //!
-//! - Define a struct `MyTimerQueue`
-//! - Implement [`TimerQueue`] for it
-//! - Register it as the global timer queue with [`timer_queue_impl`].
-//! - Ensure that you process the timer queue when `schedule_wake` is due. This usually involves
-//!   waking expired tasks, finding the next expiration time and setting an alarm.
+//! As a HAL user, you should only depend on this crate if your application does not use
+//! `embassy-executor` and your HAL does not configure a generic queue by itself.
 //!
-//! If a single global timer queue is sufficient for you, you can use the
-//! [`GlobalTimerQueue`] type, which is a wrapper around a global timer queue
-//! protected by a critical section.
-//!
-//! ```
-//! use embassy_time_queue_driver::GlobalTimerQueue;
-//! embassy_time_queue_driver::timer_queue_impl!(
-//!     static TIMER_QUEUE_DRIVER: GlobalTimerQueue
-//!         = GlobalTimerQueue::new(|next_expiration| todo!("Set an alarm"))
-//! );
-//! ```
-//!
-//! You can also use the `queue_generic` or the `queue_integrated` modules to implement your own
-//! timer queue. These modules contain queue implementations which you can wrap and tailor to
-//! your needs.
-//!
-//! If you are providing an embassy-executor implementation besides a timer queue, you can choose to
-//! expose the `integrated-timers` feature in your implementation. This feature stores timer items
-//! in the tasks themselves, so you don't need a fixed-size queue or dynamic memory allocation.
-//!
-//! ## Example
-//!
-//! ```
-//! use core::task::Waker;
-//!
-//! use embassy_time::Instant;
-//! use embassy_time::queue::TimerQueue;
-//!
-//! struct MyTimerQueue{}; // not public!
-//!
-//! impl TimerQueue for MyTimerQueue {
-//!     fn schedule_wake(&'static self, at: u64, waker: &Waker) {
-//!         todo!()
-//!     }
-//! }
-//!
-//! embassy_time_queue_driver::timer_queue_impl!(static QUEUE: MyTimerQueue = MyTimerQueue{});
-//! ```
+//! As a HAL implementer, you need to depend on this crate if you want to implement a time driver,
+//! but how you should do so is documented in [`embassy_time_driver`].
 
 use core::task::Waker;
 
-- 
cgit