diff options
| author |  Gabriel Smith <ga29smith@gmail.com>
| 2018-08-12 16:11:09 -0400 |
|---|---|---|
| committer | Gabriel Smith <ga29smith@gmail.com>
| 2018-08-12 16:16:30 -0400 |
| commit | 61c19330d5dd8b58ebd57f2e064ced4ccc4faad2 (patch) | |
| tree | abbc8d24245be2ef8417f44c411829395f1296c5 | |
| parent | 54808883deb758f698cfb1e3a7340206128dd6a7 (diff) | |
| download | cortex-m-61c19330d5dd8b58ebd57f2e064ced4ccc4faad2.tar.gz cortex-m-61c19330d5dd8b58ebd57f2e064ced4ccc4faad2.tar.zst cortex-m-61c19330d5dd8b58ebd57f2e064ced4ccc4faad2.zip | |
Correct docs for __pre_init
Signed-off-by: Gabriel Smith <ga29smith@gmail.com>
| -rw-r--r-- | cortex-m-rt/src/lib.rs | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/cortex-m-rt/src/lib.rs b/cortex-m-rt/src/lib.rs index 31e4ea3..04d5b9e 100644 --- a/cortex-m-rt/src/lib.rs +++ b/cortex-m-rt/src/lib.rs @@ -238,8 +238,10 @@ //! `__EXCEPTIONS` in the `.vector_table` section. //! //! - `__pre_init`. This is a function to be run before RAM is initialized. It defaults pointing at -//! `0` and if not changed to point to another address, usually by calling the `pre_init!` macro, -//! the `_pre_init` function is skipped. +//! `1` and if not changed to point to another address, usually by calling the `pre_init!` macro, +//! the `_pre_init` function is skipped. The function cannot default to `0` as the compiler +//! optimizes out the check for `0` under the assumption that a function pointer cannot point to +//! `0`. //! //! If you override any exception handler you'll find it as an unmangled symbol, e.g. `SysTick` or //! `SVCall`, in the output of `objdump`, |