doc: fix broken intra-doc links, make minor changes

Author: yvt

README.md

@@ -14,7 +14,7 @@ R3 is a proof-of-concept of a static RTOS that utilizes Rust's compile-time func
 
 - **All kernel objects are defined statically** for faster boot times, compile-time checking, predictable execution, reduced RAM consumption, no runtime allocation failures, and extra security.
 - A kernel and its configurator **don't require an external build tool or a specialized procedural macro**, maintaining transparency and inter-crate composability.
-- The kernel API is **not tied to a specific kernel implementation**. Kernels are provided as separate crates, one of which an application chooses and instantiates using the trait system.
+- The kernel API is **not tied to any specific kernel implementations**. Kernels are provided as separate crates, one of which an application chooses and instantiates using the trait system.
 - Leverages Rust's type safety for access control of kernel objects. Safe code can't access an object that it doesn't own.
 
 ## R3 API

src/r3/src/lib.md

@@ -13,7 +13,7 @@ R3 is a proof-of-concept of a static RTOS that utilizes Rust's compile-time func
 
 - **All kernel objects are defined statically** for faster boot times, compile-time checking, predictable execution, reduced RAM consumption, no runtime allocation failures, and extra security.
 - A kernel and its configurator **don't require an external build tool or a specialized procedural macro**, maintaining transparency and inter-crate composability.
-- The kernel API is **not tied to a specific kernel implementation**. Kernels are provided as separate crates, one of which an application chooses and instantiates using the trait system.
+- The kernel API is **not tied to any specific kernel implementations**. Kernels are provided as separate crates, one of which an application chooses and instantiates using the trait system.
 - Leverages Rust's type safety for access control of kernel objects. Safe code can't access an object that it doesn't own.
 
 See [`r3_core`]'s crate-level documentation for a general description of kernel features and concepts used in R3.

src/r3_kernel/src/lib.md

@@ -54,8 +54,8 @@ const COTTAGE: Objects = r3_kernel::build!(System, configure_app => Objects);
 
 [`r3_kernel::build!`]: crate::build
 [`r3_kernel::System`]: crate::System
-[system type]: r3#system-type
-[configuration function]: r3#static-configuration
+[system type]: r3_core#system-type
+[configuration function]: r3_core#static-configuration
 
 ## Trait Mechanics
 
@@ -148,7 +148,7 @@ static COTTAGE: Objects = {
 };
 ```
 
-[configuration function]: r3#static-configuration
+[configuration function]: r3_core#static-configuration
 [`KernelCfg1`]: crate::KernelCfg1
 [`KernelCfg2`]: crate::KernelCfg2
 
@@ -178,7 +178,7 @@ fn main() {
 }
 ```
 
-[interrupt handlers]: r3#interrupt-handling-framework
+[interrupt handlers]: r3_core#interrupt-handling-framework
 
 # Implementation-Defined Behaviors
 
@@ -188,7 +188,7 @@ fn main() {
 
 [`QueueOrder`]: r3_core::kernel::QueueOrder
 [`MutexProtocol`]: r3_core::kernel::MutexProtocol
-[`ResultCode::NoAccess`]: r3_core::Kernel::ResultCode::NoAccess
+[`ResultCode::NoAccess`]: r3_core::kernel::ResultCode::NoAccess
 
 # Cargo Features
 

src/r3_port_arm/src/lib.md

@@ -1,4 +1,4 @@
-The Arm-A port for [the R3 kernel](::r3).
+The Arm-A port for [the R3 kernel](::r3_kernel).
 
 # Startup Code
 

src/r3_port_arm_m/src/lib.md

@@ -1,4 +1,4 @@
-The Arm-M port for [the R3 kernel](::r3).
+The Arm-M port for [the R3 kernel](::r3_kernel).
 
 # Interrupts
 

src/r3_port_riscv/src/lib.md

@@ -1,4 +1,4 @@
-The RISC-V port for [the R3 kernel](::r3).
+The RISC-V port for [the R3 kernel](::r3_kernel).
 
 # Startup code
 
@@ -32,11 +32,11 @@ The local interrupts are always enabled from an API point of view. **[`Interrupt
 [`InterruptLine::disable`]: r3_core::kernel::InterruptLine::disable
 [Pend]: r3_core::kernel::InterruptLine::pend
 [`NotSupported`]: r3_core::kernel::EnableInterruptLineError::NotSupported
-[*managed*]: r3#interrupt-handling-framework
+[*managed*]: r3_core#interrupt-handling-framework
 
 <div class="admonition-follows"></div>
 
-> **Rationale:** Because their enable bits are toggled frequently in the top-level interrupt handler, removing the ability to disable these interrupts simplifies the implementation and reduces interupt latency. This should pose no problems for most cases.
+> **Rationale:** Because their enable bits are toggled frequently in the top-level interrupt handler, removing the ability to disable these interrupts simplifies the implementation and reduces interupt latency. This should pose no problems in most cases.
 
 The local interrupts are always [*managed*]. This is because CPU Lock is currently mapped to `mstatus.MIE` (global interrupt-enable).
 
@@ -193,7 +193,7 @@ The idle task (the implicit task that runs when `*`[`running_task_ptr`]`().is_no
 
 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 `x` registers, which might help in debugging at the cost of performance and code size.
 
-The trap handler stores a first-level state directly below the current stack pointer. This means **the stack pointer must be aligned to a `max(XLEN, FLEN)`-bit boundary all the time**. This requirement is weaker than the standard ABI's requirement, so it shouldn't pose a problem for most cases.
+The trap handler stores a first-level state directly below the current stack pointer. This means **the stack pointer must be aligned to a `max(XLEN, FLEN)`-bit boundary all the time**. This requirement is weaker than the standard ABI's requirement, so it shouldn't pose a problem in most cases.
 
 ## Processor Modes
 

src/r3_port_riscv/src/threading/cfg.rs

@@ -9,7 +9,7 @@ pub const INTERRUPT_TIMER: InterruptNum = 1;
 /// The interrupt number for external interrupts.
 pub const INTERRUPT_EXTERNAL: InterruptNum = 2;
 
-/// The first interrupt numbers allocated for use by an interrupt controller
+/// The first interrupt number allocated for use by an interrupt controller
 /// driver.
 pub const INTERRUPT_PLATFORM_START: InterruptNum = 3;
 

src/r3_port_std/src/lib.md

@@ -1,4 +1,4 @@
-Simulator for running [`::r3`] on a hosted environment
+The port for running [`::r3_kernel`][] in a hosted environment
 
 # Usage
 
@@ -55,7 +55,7 @@ This port fully supports [the standard interrupt handling framework].
  - Smaller priority values are prioritized.
  - Negative priority values are considered unmanaged.
 
-[the standard interrupt handling framework]: ::r3#interrupt-handling-framework
+[the standard interrupt handling framework]: r3_core#interrupt-handling-framework
 [`NUM_INTERRUPT_LINES`]: crate::NUM_INTERRUPT_LINES
 
 ## Implementation

src/r3_test_suite/src/lib.md

@@ -1,8 +1,8 @@
-A collection of tests that can be used to verify the correct operation of [the R3 kernel] and a port implementation.
+A collection of tests that can be used to verify the correct operation of [the R3 kernel][] and a port implementation.
 
 <div class="distractor"><a style="background-image: url(https://derpicdn.net/img/2014/4/5/593273/medium.png); padding-bottom: 66.66%" href="http://derpibooru.org/593273" title="She passed!"></a></div>
 
-[the R3 kernel]: r3
+[the R3 kernel]: r3_kernel
 
 # Terminology
 
@@ -65,7 +65,7 @@ pub mod test3 { /* ... */ }
 
 [`kernel_tests`]: crate::kernel_tests
 [`basic`]: crate::kernel_tests::basic
-[a configuration function]: r3#static-configuration
+[a configuration function]: r3_core#static-configuration
 [`Driver`]: crate::kernel_tests::Driver
 
 A test runner should choose one of test cases, link it to a test driver, run it, and retrieve and report the result. This should be repeated for all test cases.