Skip to content

Commit bd8bd04

Browse files
committed
docs: modernize intra-doc links
1 parent 9b4ac44 commit bd8bd04

5 files changed

Lines changed: 10 additions & 10 deletions

File tree

src/lib.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@
2828
//! - Please refer to the [`unsafe` in `gdbstub`](https://github.com/daniel5151/gdbstub#unsafe-in-gdbstub)
2929
//! section of the README.md for more details.
3030
//! - `core_error`
31-
//! - Make `GdbStubError` implement [`core::error::Error`](https://doc.rust-lang.org/core/error/trait.Error.html)
32-
//! instead of `std::error::Error`.
31+
//! - Make `GdbStubError` implement [`core::error::Error`] instead of
32+
//! [`std::error::Error`].
3333
//!
3434
//! ## Getting Started
3535
//!

src/target/ext/extended_mode.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ pub trait ExtendedMode: Target {
7474
///
7575
/// _Note:_ This method's implementation should handle any additional
7676
/// configuration options set via the various `ConfigureXXX` extensions to
77-
/// `ExtendedMode`. e.g: if the [`ConfigureEnv`](trait.ConfigureEnv.html)
77+
/// `ExtendedMode`. e.g: if the [`ConfigureEnv`]
7878
/// extension is implemented and enabled, this method should set the spawned
7979
/// processes' environment variables accordingly.
8080
fn run(&mut self, filename: Option<&[u8]>, args: Args<'_, '_>) -> TargetResult<Pid, Self>;

src/target/ext/monitor_cmd.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ pub trait MonitorCmd: Target {
2121
///
2222
/// Intermediate console output can be written back to the GDB client using
2323
/// the provided `ConsoleOutput` object + the
24-
/// [`gdbstub::output!`](macro.output.html) macro.
24+
/// [`gdbstub::output!`](output) macro.
2525
///
2626
/// _Note:_ The maximum length of incoming commands is limited by the size
27-
/// of the packet buffer provided to the [`GdbStub`](struct.GdbStub.html).
27+
/// of the packet buffer provided to the [`GdbStub`](crate::stub::GdbStub).
2828
/// Specifically, commands can only be up to `(buf.len() - 10) / 2` bytes.
2929
fn handle_monitor_cmd(&mut self, cmd: &[u8], out: ConsoleOutput<'_>)
3030
-> Result<(), Self::Error>;

src/target/ext/section_offsets.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,8 @@ pub enum Offsets<U> {
6363

6464
/// Target Extension - Get section/segment relocation offsets from the target.
6565
///
66-
/// Corresponds to the `qOffset` command. See the [section_offset module
67-
/// documentation](index.html).
66+
/// Corresponds to the `qOffset` command. See the [module docs](self) for
67+
/// additional context.
6868
pub trait SectionOffsets: Target {
6969
/// Return the target's current section (or segment) offsets.
7070
fn get_section_offsets(&mut self) -> Result<Offsets<<Self::Arch as Arch>::Usize>, Self::Error>;

src/target/mod.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
//! type encodes information about the target's architecture, such as its
3232
//! pointer size, register layout, etc... `gdbstub` comes with several
3333
//! built-in architecture definitions, which can be found under the
34-
//! [`arch`](../arch/index.html) module.
34+
//! [`arch`](crate::arch) module.
3535
//!
3636
//! - The [`Target::Error`](trait.Target.html#associatedtype.Error) associated
3737
//! type allows implementors to plumb-through their own project-specific fatal
@@ -353,9 +353,9 @@ impl<E> From<std::io::Error> for TargetError<E> {
353353
pub type TargetResult<T, Tgt> = Result<T, TargetError<<Tgt as Target>::Error>>;
354354

355355
/// Describes the architecture and capabilities of a target which can be
356-
/// debugged by [`GdbStub`](../struct.GdbStub.html).
356+
/// debugged by [`GdbStub`](crate::stub::GdbStub).
357357
///
358-
/// The [`Target`](trait.Target.html) trait describes how to control and modify
358+
/// The [`Target`] trait describes how to control and modify
359359
/// a system's execution state during a GDB debugging session, and serves as the
360360
/// primary bridge between `gdbstub`'s generic protocol implementation and a
361361
/// target's project/platform-specific code.

0 commit comments

Comments
 (0)