Merge #144

144: [RFC] rename UserHardFault to HardFault r=adamgreig a=japaric

so it matches the exception name (`#[exception] fn HardFault(..`)

Right now the symbol name of all exception handlers match the name of the
function used with the `#[exception]` attribute *except* for `HardFault`, whose
symbol name actually is `UserHardFault`.

This PR corrects that inconsistency by renaming the `UserHardFault` symbol to
`HardFault`, and the `HardFault` symbol to `HardFaultTrampoline`.

This change doesn't break compilation or changes functionality but it does soft
break GDB scripts that include the command `break UserHardFault` (e.g. the GDB
script in cortex-m-quickstart) in the sense that the breakpoint will no longer
work. However the rest of the GDB script will continue to work.

RFC questions: (a) do we want to do this rename? (b) if the answer is yes, do we
want to include this rename in the v0.5.x release, or should we consider it a
breaking change and postpone it until v0.6.0?

Co-authored-by: Jorge Aparicio <jorge@japaric.io>

1 files changed, 2 insertions, 2 deletions

diff --git a/cortex-m-rt/macros/src/lib.rs b/cortex-m-rt/macros/src/lib.rs
index dfa936b..1013f5e 100644
--- a/cortex-m-rt/macros/src/lib.rs
+++ b/cortex-m-rt/macros/src/lib.rs
@@ -397,8 +397,8 @@ pub fn exception(args: TokenStream, input: TokenStream) -> TokenStream {
             let pat = &arg.pat;
 
             quote!(
-                #[export_name = "UserHardFault"]
-                #[link_section = ".UserHardFault"]
+                #[export_name = "HardFault"]
+                #[link_section = ".HardFault.user"]
                 #(#attrs)*
                 pub #unsafety extern "C" fn #hash(#arg) -> ! {
                     extern crate cortex_m_rt;