Skip to content

Commit

Permalink
docs: fix documentation links and publicize Handle
Browse files Browse the repository at this point in the history
  • Loading branch information
Qix- committed Sep 11, 2024
1 parent 09a92a4 commit 93bd74b
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 4 deletions.
3 changes: 1 addition & 2 deletions oro-kernel/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,9 @@ use oro_sync::spinlock::unfair_critical::{InterruptController, UnfairCriticalSpi
pub mod id;
pub mod module;
pub mod port;
pub mod registry;
pub mod ring;

pub(crate) mod registry;

/// Core-local instance of the Oro kernel.
///
/// Intended to live on the core's respective stack,
Expand Down
4 changes: 2 additions & 2 deletions oro-kernel/src/registry.rs
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ use oro_sync::spinlock::unfair_critical::{InterruptController, UnfairCriticalSpi
///
/// Registry allocations return [`Handle`]s, which can be cloned
/// and will free the slot when the final user drops it.
pub struct Registry<T, IntCtrl, AddrSpace, Pat>
pub(crate) struct Registry<T, IntCtrl, AddrSpace, Pat>
where
T: Sized + 'static,
IntCtrl: InterruptController,
Expand Down Expand Up @@ -399,7 +399,7 @@ where
}
}

/// A lightweight handle to an item in a [`Registry`].
/// A lightweight handle to an item in a registry.
///
/// The handle is a reference-counted item in the registry,
/// and is a thin wrapper around an [`UnfairCriticalSpinlock`]
Expand Down

0 comments on commit 93bd74b

Please sign in to comment.