Skip to content

Commit 429ba4b

Browse files
committed
Add some details to the docs
1 parent ed2c6f0 commit 429ba4b

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

riscv-rt/src/lib.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -605,8 +605,12 @@
605605
//! To use it, the user must define a symbol named `_pre_default_start_trap`, which the system will jump to.
606606
//! After executing the custom code, control should return by jumping to `_pre_default_start_trap_ret`.
607607
//!
608+
//! It's recommended to place the code in the `.trap.start` section to make sure it's reachable from `_default_start_trap`.
609+
//!
608610
//! It is expected that the custom code does not clobber any registers.
609611
//!
612+
//! Please note that your code won't be run for interrupts in vectored mode.
613+
//!
610614
//! ### Example
611615
//!
612616
//! ```rust,no_run

0 commit comments

Comments
 (0)