Skip to content

Commit 78764c2

Browse files
committed
Fix some documentation nits
1 parent 2abb586 commit 78764c2

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

arch/riscv/src/lib.rs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -97,9 +97,9 @@ core::arch::global_asm!(crate::easm!("
9797
// that the linker can emit code with offsets that are relative to
9898
// the gp register, and the CPU can successfully execute them.
9999
//
100-
// https://gnu-mcu-eclipse.github.io/arch/riscv/programmer/#the-gp-global-pointer-register
101-
// https://groups.google.com/a/groups.riscv.org/forum/#!msg/sw-dev/60IdaZj27dY/5MydPLnHAQAJ
102-
// https://www.sifive.com/blog/2017/08/28/all-aboard-part-3-linker-relaxation-in-riscv-toolchain/
100+
// <https://gnu-mcu-eclipse.github.io/arch/riscv/programmer/#the-gp-global-pointer-register>
101+
// <https://groups.google.com/a/groups.riscv.org/forum/#!msg/sw-dev/60IdaZj27dY/5MydPLnHAQAJ>
102+
// <https://www.sifive.com/blog/2017/08/28/all-aboard-part-3-linker-relaxation-in-riscv-toolchain/>
103103
// Likely not a good idea to allow the linker to use global pointer to derive global pointer
104104
.option push
105105
.option norelax
@@ -228,7 +228,7 @@ extern "C" {
228228
/// If it contains any other value, we interpret it to be a memory address
229229
/// pointing to a particular data structure:
230230
///
231-
/// ```
231+
/// ```raw
232232
/// mscratch 0 1 2 3
233233
/// \->|--------------------------------------------------------------|
234234
/// | scratch word, overwritten with s1 register contents |
@@ -401,15 +401,15 @@ core::arch::global_asm!(crate::easm!(
401401

402402
/// RISC-V semihosting needs three exact instructions in uncompressed form.
403403
///
404-
/// See https://github.com/riscv/riscv-semihosting-spec/blob/main/riscv-semihosting-spec.adoc#11-semihosting-trap-instruction-sequence
404+
/// See <https://github.com/riscv/riscv-semihosting-spec/blob/main/riscv-semihosting-spec.adoc#11-semihosting-trap-instruction-sequence>
405405
/// for more details on the three instructions.
406406
///
407407
/// In order to work with semihosting we include the assembly here
408408
/// where we are able to disable compressed instruction support. This
409409
/// follows the example used in the Linux kernel:
410-
/// https://elixir.bootlin.com/linux/v5.12.10/source/arch/riscv/include/asm/jump_label.h#L21
410+
/// <https://elixir.bootlin.com/linux/v5.12.10/source/arch/riscv/include/asm/jump_label.h#L21>
411411
/// as suggested by the RISC-V developers:
412-
/// https://groups.google.com/a/groups.riscv.org/g/isa-dev/c/XKkYacERM04/m/CdpOcqtRAgAJ
412+
/// <https://groups.google.com/a/groups.riscv.org/g/isa-dev/c/XKkYacERM04/m/CdpOcqtRAgAJ>
413413
#[cfg(all(
414414
any(target_arch = "riscv32", target_arch = "riscv64"),
415415
target_os = "none"

kernel/src/grant.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -623,7 +623,7 @@ impl<'a> GrantKernelData<'a> {
623623
/// Search the work queue for the first pending operation with the given
624624
/// `subscribe_num` and if one exists remove it from the task queue.
625625
///
626-
/// Returns the associated [`Task`] if one was found, otherwise returns
626+
/// Returns the associated [`Task`](crate::process::Task) if one was found, otherwise returns
627627
/// [`None`].
628628
pub fn remove_upcall(&self, subscribe_num: usize) -> Option<crate::process::Task> {
629629
self.process.remove_upcall(UpcallId {

kernel/src/processbuffer.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -267,8 +267,8 @@ impl ReadOnlyProcessBuffer {
267267
/// # Safety requirements
268268
///
269269
/// The caller must ensure that the memory `ptr` and `len` refer to was, at some point, derived from a
270-
/// [CapabilityPtr] from the process which was valid for a read operation (e.g. using
271-
/// [is_valid_for_operation]).
270+
/// [CapabilityPtr](crate::utilities::capability_ptr::CapabilityPtr) from the process which was valid for a read operation (e.g. using
271+
/// [CapabilityPtr::is_valid_for_operation](crate::utilities::capability_ptr::CapabilityPtr::is_valid_for_operation)).
272272
///
273273
/// If the length is `0`, an arbitrary pointer may be passed into
274274
/// `ptr`. It does not necessarily have to point to allocated

0 commit comments

Comments
 (0)