Skip to content

Commit 0df6752

Browse files
committed
Mention value of STACK_PAINT_VALUE
1 parent 1074ea5 commit 0df6752

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

cortex-m-rt/src/lib.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,8 @@
187187
//!
188188
//! ## `paint-stack`
189189
//!
190-
//! Everywhere between `__sheap` and `___stack_start` is painted with the fixed value `STACK_PAINT_VALUE`.
190+
//! Everywhere between `__sheap` and `___stack_start` is painted with the fixed value
191+
//! `STACK_PAINT_VALUE`, which is `0xCCCC_CCCC`.
191192
//! You can then inspect memory during debugging to determine how much of the stack has been used -
192193
//! where the stack has been used the 'paint' will have been 'scrubbed off' and the memory will
193194
//! have a value other than `STACK_PAINT_VALUE`.
@@ -475,9 +476,8 @@
475476
extern crate cortex_m_rt_macros as macros;
476477

477478
/// The 32-bit value the stack is painted with before the program runs.
478-
///
479-
/// Note: keep this value in-sync with the start-up assembly code, as we can't
480-
/// use const values in `global_asm!` yet.
479+
// Note: keep this value in-sync with the start-up assembly code, as we can't
480+
// use const values in `global_asm!` yet.
481481
#[cfg(feature = "paint-stack")]
482482
pub const STACK_PAINT_VALUE: u32 = 0xcccc_cccc;
483483

0 commit comments

Comments
 (0)