Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
DrChat committed Jun 1, 2021
1 parent 6b19ed0 commit 04faf0a
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
5 changes: 4 additions & 1 deletion src/arch.rs
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,10 @@ use crate::internal::{BeBytes, LeBytes};
///
/// [single register accesses]: crate::target::ext::base::SingleRegisterAccess
pub trait RegId: Sized + Debug {
/// Map raw GDB register number corresponding `RegId` and register size.
/// Map raw GDB register number to a corresponding `RegId` and optional register size.
///
/// If the register size is specified here, no more than that amount of bytes will be
/// permitted to be transferred on the wire for that register.
///
/// Returns `None` if the register is not available.
fn from_raw_id(id: usize) -> Option<(Self, Option<NonZeroUsize>)>;
Expand Down
2 changes: 1 addition & 1 deletion src/target/ext/base/single_register_access.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ pub trait SingleRegisterAccess<Id>: Target {
/// On single threaded targets, `tid` is set to `()` and can be ignored.
///
/// Implementations should write the value of the register using target's
/// native byte order in the buffer `dst`.
/// native byte order when writing via `output`.
///
/// If the requested register could not be accessed, an appropriate
/// non-fatal error should be returned.
Expand Down

0 comments on commit 04faf0a

Please sign in to comment.