doc(port_arm): fix broken intra-doc links

yvt · yvt · commit 9a16a6176e8e · 2021-12-01T09:13:45.000+09:00
diff --git a/src/r3_port_arm/src/gic/cfg.rs b/src/r3_port_arm/src/gic/cfg.rs
@@ -12,7 +12,7 @@ use super::{gic_regs, imp::GicRegs};
 /// the target.
 /// **Requires [`GicOptions`].**
 ///
-/// [`PortInterrupts`]: r3::kernel::PortInterrupts
+/// [`PortInterrupts`]: r3_kernel::PortInterrupts
 /// [`InterruptController`]: crate::InterruptController
 ///
 /// # Safety
diff --git a/src/r3_port_arm/src/gic/imp.rs b/src/r3_port_arm/src/gic/imp.rs
@@ -110,7 +110,7 @@ pub fn end_interrupt<Traits: Gic>(num: InterruptNum) {
     cpu_interface.EOIR.set(num as _);
 }
 
-/// Implements [`r3::kernel::PortInterrupts::set_interrupt_line_priority`].
+/// Implements [`r3_kernel::PortInterrupts::set_interrupt_line_priority`].
 pub fn set_interrupt_line_priority<Traits: Gic>(
     line: InterruptNum,
     priority: InterruptPriority,
@@ -126,7 +126,7 @@ pub fn set_interrupt_line_priority<Traits: Gic>(
     Ok(())
 }
 
-/// Implements [`r3::kernel::PortInterrupts::enable_interrupt_line`].
+/// Implements [`r3_kernel::PortInterrupts::enable_interrupt_line`].
 pub fn enable_interrupt_line<Traits: Gic>(
     line: InterruptNum,
 ) -> Result<(), EnableInterruptLineError> {
@@ -142,7 +142,7 @@ pub fn enable_interrupt_line<Traits: Gic>(
     Ok(())
 }
 
-/// Implements [`r3::kernel::PortInterrupts::disable_interrupt_line`].
+/// Implements [`r3_kernel::PortInterrupts::disable_interrupt_line`].
 pub fn disable_interrupt_line<Traits: Gic>(
     line: InterruptNum,
 ) -> Result<(), EnableInterruptLineError> {
@@ -158,7 +158,7 @@ pub fn disable_interrupt_line<Traits: Gic>(
     Ok(())
 }
 
-/// Implements [`r3::kernel::PortInterrupts::pend_interrupt_line`].
+/// Implements [`r3_kernel::PortInterrupts::pend_interrupt_line`].
 pub fn pend_interrupt_line<Traits: Gic>(line: InterruptNum) -> Result<(), PendInterruptLineError> {
     let distributor = Traits::gic_regs().distributor;
 
@@ -173,7 +173,7 @@ pub fn pend_interrupt_line<Traits: Gic>(line: InterruptNum) -> Result<(), PendIn
     Ok(())
 }
 
-/// Implements [`r3::kernel::PortInterrupts::clear_interrupt_line`].
+/// Implements [`r3_kernel::PortInterrupts::clear_interrupt_line`].
 pub fn clear_interrupt_line<Traits: Gic>(
     line: InterruptNum,
 ) -> Result<(), ClearInterruptLineError> {
@@ -190,7 +190,7 @@ pub fn clear_interrupt_line<Traits: Gic>(
     Ok(())
 }
 
-/// Implements [`r3::kernel::PortInterrupts::is_interrupt_line_pending`].
+/// Implements [`r3_kernel::PortInterrupts::is_interrupt_line_pending`].
 pub fn is_interrupt_line_pending<Traits: Gic>(
     line: InterruptNum,
 ) -> Result<bool, QueryInterruptLineError> {
diff --git a/src/r3_port_arm/src/lib.md b/src/r3_port_arm/src/lib.md
@@ -63,8 +63,8 @@ The valid priority range is `0..255`. All priorities are [*managed*] - unmanaged
 
 The GIC driver exposes additional operations on interrupt lines through [`Gic`] implemented on your kernel trait type.
 
-[`PortInterrupts`]: r3::kernel::PortInterrupts
-[*managed*]: r3::kernel::PortInterrupts::MANAGED_INTERRUPT_PRIORITY_RANGE
+[`PortInterrupts`]: r3_kernel::PortInterrupts
+[*managed*]: r3_kernel::PortInterrupts::MANAGED_INTERRUPT_PRIORITY_RANGE
 
 # Implementation
 
@@ -112,7 +112,7 @@ struct ContextState {
 
 `sp` is stored in [`TaskCb::port_task_state`].
 
-[`TaskCb::port_task_state`]: r3::kernel::TaskCb::port_task_state
+[`TaskCb::port_task_state`]: r3_kernel::TaskCb::port_task_state
 
 When a task is activated, a new context state is created inside the task's stack. By default, only essential registers are preloaded with known values. The **`preload-registers`** Cargo feature enables preloading for all GPRs, which might help in debugging at the cost of performance and code size.
 
@@ -124,4 +124,4 @@ For the idle task, saving and restoring the context store is essentially replace
  - **Supervisor**: Non-task context
  - **IRQ**: The processor enters this mode when it takes an exception. This state lasts only briefly because the IRQ handler switches to Supervisor as soon as possible to allow reentry. `sp_irq` is only used as a scratch register.
 
-[`running_task_ptr`]: r3::kernel::State::running_task_ptr
+[`running_task_ptr`]: r3_kernel::State::running_task_ptr
diff --git a/src/r3_port_arm/src/sp804/cfg.rs b/src/r3_port_arm/src/sp804/cfg.rs
@@ -6,7 +6,7 @@ use r3::kernel::{InterruptNum, InterruptPriority};
 /// also implements [`Timer`] on the kernel trait type.
 /// **Requires [`Sp804Options`].**
 ///
-/// [`PortTimer`]: r3::kernel::PortTimer
+/// [`PortTimer`]: r3_kernel::PortTimer
 /// [`Timer`]: crate::Timer
 /// [Arm PrimeCell SP804 Dual Timer]: https://developer.arm.com/documentation/ddi0271/d/
 ///
diff --git a/src/r3_port_arm/src/sp804/imp.rs b/src/r3_port_arm/src/sp804/imp.rs
@@ -121,7 +121,7 @@ fn hw_tick_count<Traits: Sp804Instance>() -> u32 {
     hw_tick_count
 }
 
-/// Implements [`r3::kernel::PortTimer::tick_count`]
+/// Implements [`r3_kernel::PortTimer::tick_count`]
 ///
 /// # Safety
 ///
@@ -136,7 +136,7 @@ pub unsafe fn tick_count<Traits: Sp804Instance>() -> UTicks {
     tstate.tick_count(tcfg, hw_tick_count)
 }
 
-/// Implements [`r3::kernel::PortTimer::pend_tick`]
+/// Implements [`r3_kernel::PortTimer::pend_tick`]
 ///
 /// # Safety
 ///
@@ -147,7 +147,7 @@ pub unsafe fn pend_tick<Traits: Sp804Instance>() {
         .unwrap();
 }
 
-/// Implements [`r3::kernel::PortTimer::pend_tick_after`]
+/// Implements [`r3_kernel::PortTimer::pend_tick_after`]
 ///
 /// # Safety
 ///
diff --git a/src/r3_port_arm/src/threading/cfg.rs b/src/r3_port_arm/src/threading/cfg.rs
@@ -7,7 +7,7 @@ pub trait InterruptController {
     /// Initialize the driver. This will be called just before entering
     /// [`PortToKernel::boot`].
     ///
-    /// [`PortToKernel::boot`]: r3::kernel::PortToKernel::boot
+    /// [`PortToKernel::boot`]: r3_kernel::PortToKernel::boot
     ///
     /// # Safety
     ///
@@ -36,7 +36,7 @@ pub trait Timer {
     /// Initialize the driver. This will be called just before entering
     /// [`PortToKernel::boot`].
     ///
-    /// [`PortToKernel::boot`]: r3::kernel::PortToKernel::boot
+    /// [`PortToKernel::boot`]: r3_kernel::PortToKernel::boot
     ///
     /// # Safety
     ///
@@ -72,7 +72,7 @@ pub trait EntryPoint {
 /// [`EntryPoint`]. **Requires [`ThreadingOptions`], [`InterruptController`],
 /// and [`Timer`].**
 ///
-/// [`PortThreading`]: r3::kernel::PortThreading
+/// [`PortThreading`]: r3_kernel::PortThreading
 #[macro_export]
 macro_rules! use_port {
     (unsafe $vis:vis struct $Traits:ident) => {
diff --git a/src/r3_port_arm/src/threading/imp.rs b/src/r3_port_arm/src/threading/imp.rs
@@ -148,7 +148,7 @@ impl State {
     ///     - Push the second-level state.
     ///     - Store SP to the current task's `TaskState`.
     ///  - **`dispatch:`** (alternate entry point)
-    ///     - Call [`r3::kernel::PortToKernel::choose_running_task`].
+    ///     - Call [`r3_kernel::PortToKernel::choose_running_task`].
     ///     - Restore SP from the next scheduled task's `TaskState`.
     ///  - If there's no task to schedule, branch to [`Self::idle_task`].
     ///  - Pop the second-level state of the next scheduled task.
