From 1f0075386fa30536af1e27ec2ecc9437793e8aef Mon Sep 17 00:00:00 2001 From: Brad Campbell Date: Tue, 2 Jul 2024 17:14:18 -0400 Subject: [PATCH] arch: cortex-m: fix docs We can't link to CortexMVariant because it is not a dependency. Include <> so that the tool which knows that is a link knows that is a link. --- arch/cortex-m/src/lib.rs | 2 +- arch/cortex-v7m/src/lib.rs | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/arch/cortex-m/src/lib.rs b/arch/cortex-m/src/lib.rs index f75ddab39b..83f43d4c5d 100644 --- a/arch/cortex-m/src/lib.rs +++ b/arch/cortex-m/src/lib.rs @@ -140,7 +140,7 @@ extern "C" { /// We need to (unfortunately) do these operations in assembly because it is /// not valid to run Rust code without RAM initialized. /// - /// See https://github.com/tock/tock/issues/2222 for more information. + /// See for more information. pub fn initialize_ram_jump_to_main(); } diff --git a/arch/cortex-v7m/src/lib.rs b/arch/cortex-v7m/src/lib.rs index 9ced4afec1..0f1e14e7f5 100644 --- a/arch/cortex-v7m/src/lib.rs +++ b/arch/cortex-v7m/src/lib.rs @@ -22,7 +22,7 @@ extern "C" { /// ARMv7-M systick handler function. /// /// For documentation of this function, please see - /// [`CortexMVariant::SYSTICK_HANDLER`]. + /// `CortexMVariant::SYSTICK_HANDLER`. pub fn systick_handler_arm_v7m(); } @@ -63,7 +63,7 @@ extern "C" { /// Handler of `svc` instructions on ARMv7-M. /// /// For documentation of this function, please see - /// [`CortexMVariant::SVC_HANDLER`]. + /// `CortexMVariant::SVC_HANDLER`. pub fn svc_handler_arm_v7m(); } @@ -140,7 +140,7 @@ global_asm!( extern "C" { /// Generic interrupt handler for ARMv7-M instruction sets. /// - /// For documentation of this function, see [`CortexMVariant::GENERIC_ISR`]. + /// For documentation of this function, see `CortexMVariant::GENERIC_ISR`. pub fn generic_isr_arm_v7m(); } #[cfg(all(target_arch = "arm", target_os = "none"))] @@ -219,7 +219,7 @@ global_asm!( /// state. /// /// For documentation of this function, please see -/// [`CortexMVariant::switch_to_user`]. +/// `CortexMVariant::switch_to_user`. #[cfg(all(target_arch = "arm", target_os = "none"))] pub unsafe fn switch_to_user_arm_v7m( mut user_stack: *const usize, @@ -439,7 +439,7 @@ extern "C" { /// ARMv7-M hardfault handler. /// /// For documentation of this function, please see - /// [`CortexMVariant::HARD_FAULT_HANDLER_HANDLER`]. + /// `CortexMVariant::HARD_FAULT_HANDLER_HANDLER`. pub fn hard_fault_handler_arm_v7m(); }