Skip to content

Commit 19ad5b1

Browse files
committed
doc(r3): don't assume r3_kernel
1 parent a13d68e commit 19ad5b1

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

src/r3/src/kernel/error.rs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -778,7 +778,7 @@ define_error! {
778778
/// [`InterruptLine::set_priority`]: super::InterruptLine::set_priority
779779
/// [`InterruptLine::set_priority_unchecked`]: super::InterruptLine::set_priority_unchecked
780780
pub enum SetInterruptLinePriorityError {
781-
/// The operation is not supported by the port.
781+
/// The operation is not supported by the kernel.
782782
NotSupported,
783783
/// CPU Lock is active, or the current context is not [a task context].
784784
///
@@ -797,7 +797,7 @@ define_error! {
797797
/// [`InterruptLine::enable`]: super::InterruptLine::enable
798798
/// [`InterruptLine::disable`]: super::InterruptLine::disable
799799
pub enum EnableInterruptLineError {
800-
/// The operation is not supported by the port.
800+
/// The operation is not supported by the kernel.
801801
NotSupported,
802802
/// Enabling or disabling the specified interrupt line is not supported.
803803
BadParam,
@@ -810,7 +810,7 @@ define_error! {
810810
///
811811
/// [`InterruptLine::pend`]: super::InterruptLine::pend
812812
pub enum PendInterruptLineError {
813-
/// Setting a pending flag is not supported by the port.
813+
/// Setting a pending flag is not supported by the kernel.
814814
NotSupported,
815815
/// Setting the pending flag of the specified interrupt line is not
816816
/// supported.
@@ -819,7 +819,7 @@ define_error! {
819819
/// example, this operation is invalid for an level-triggered interrupt
820820
/// line.
821821
///
822-
/// A port is not required to detect this condition.
822+
/// A kernel is not required to detect this condition.
823823
BadObjectState,
824824
}
825825
}
@@ -830,7 +830,7 @@ define_error! {
830830
///
831831
/// [`InterruptLine::clear`]: super::InterruptLine::clear
832832
pub enum ClearInterruptLineError {
833-
/// Clearing a pending flag is not supported by the port.
833+
/// Clearing a pending flag is not supported by the kernel.
834834
NotSupported,
835835
/// Clearing the pending flag of the specified interrupt line is not
836836
/// supported.
@@ -839,7 +839,7 @@ define_error! {
839839
/// example, this operation is invalid for an level-triggered interrupt
840840
/// line.
841841
///
842-
/// A port is not required to detect this condition.
842+
/// A kernel is not required to detect this condition.
843843
BadObjectState,
844844
}
845845
}
@@ -850,7 +850,7 @@ define_error! {
850850
///
851851
/// [`InterruptLine::is_pending`]: super::InterruptLine::is_pending
852852
pub enum QueryInterruptLineError {
853-
/// Reading a pending flag is not supported by the port.
853+
/// Reading a pending flag is not supported by the kernel.
854854
NotSupported,
855855
/// Reading the pending flag of the specified interrupt line is not
856856
/// supported.

src/r3/src/kernel/kernel.rs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -143,8 +143,8 @@ pub trait Kernel: private::Sealed {
143143
/// <div class="admonition-follows"></div>
144144
///
145145
/// > **Rationale:** This restriction originates from μITRON4.0. It's
146-
/// > actually unnecessary in the current implementation, but allows
147-
/// > headroom for potential changes in the implementation.
146+
/// > actually unnecessary in `r3_kernel`'s current implementation, but
147+
/// > allows more leeway in a kernel implementation.
148148
fn set_time(time: Time) -> Result<(), TimeError>;
149149

150150
/// Get the current [system time].
@@ -157,8 +157,8 @@ pub trait Kernel: private::Sealed {
157157
/// <div class="admonition-follows"></div>
158158
///
159159
/// > **Rationale:** This restriction originates from μITRON4.0. It's
160-
/// > actually unnecessary in the current implementation, but allows
161-
/// > headroom for potential changes in the implementation.
160+
/// > actually unnecessary in `r3_kernel`'s current implementation, but
161+
/// > allows more leeway in a kernel implementation.
162162
fn time() -> Result<Time, TimeError>
163163
where
164164
Self: raw::KernelTime;
@@ -202,7 +202,7 @@ pub trait Kernel: private::Sealed {
202202
/// make the event overdue by more than `time_user_headroom`), the check
203203
/// will fail.
204204
///
205-
/// The events made overdue by the call will be processed when the port
205+
/// The events made overdue by the call will be processed when the
206206
/// timer driver announces a new tick. It's unspecified whether this happens
207207
/// before or after the call returns.
208208
///
@@ -295,8 +295,8 @@ pub trait Kernel: private::Sealed {
295295

296296
/// Terminate the current task, putting it into the Dormant state.
297297
///
298-
/// The kernel (to be precise, the port) makes an implicit call to this
299-
/// function when a task entry point function returns.
298+
/// The kernel makes an implicit call to this function when a task entry
299+
/// point function returns.
300300
///
301301
/// # Safety
302302
///

src/r3/src/kernel/raw.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -519,7 +519,7 @@ pub unsafe trait KernelInterruptLine: KernelBase {
519519

520520
/// Numeric value used to identify interrupt lines.
521521
///
522-
/// The meaning of this value is defined by a port and target hardware. They
522+
/// The meaning of this value is defined by a kernel and target hardware. They
523523
/// are not necessarily tightly packed from zero.
524524
pub type InterruptNum = usize;
525525

0 commit comments

Comments
 (0)