Skip to content

Commit 59e45c4

Browse files
committed
Update documentation
1 parent 6b19ed0 commit 59e45c4

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

src/arch.rs

+6-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,12 @@ use crate::internal::{BeBytes, LeBytes};
2828
///
2929
/// [single register accesses]: crate::target::ext::base::SingleRegisterAccess
3030
pub trait RegId: Sized + Debug {
31-
/// Map raw GDB register number corresponding `RegId` and register size.
31+
/// Map raw GDB register number to a corresponding `RegId` and optional
32+
/// register size.
33+
///
34+
/// If the register size is specified here, no more than that amount of
35+
/// bytes will be permitted to be transferred on the wire for that
36+
/// register.
3237
///
3338
/// Returns `None` if the register is not available.
3439
fn from_raw_id(id: usize) -> Option<(Self, Option<NonZeroUsize>)>;

src/target/ext/base/single_register_access.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ pub trait SingleRegisterAccess<Id>: Target {
2222
/// On single threaded targets, `tid` is set to `()` and can be ignored.
2323
///
2424
/// Implementations should write the value of the register using target's
25-
/// native byte order in the buffer `dst`.
25+
/// native byte order when writing via `output`.
2626
///
2727
/// If the requested register could not be accessed, an appropriate
2828
/// non-fatal error should be returned.

0 commit comments

Comments
 (0)