diff options
Diffstat (limited to 'libraries/libprof')
-rw-r--r-- | libraries/libprof/README.md (renamed from libraries/libprof/README.txt) | 16 |
1 files changed, 7 insertions, 9 deletions
diff --git a/libraries/libprof/README.txt b/libraries/libprof/README.md index f0bacc7..d464644 100644 --- a/libraries/libprof/README.txt +++ b/libraries/libprof/README.md @@ -5,7 +5,7 @@ Origin ------ This code was copied from https://github.com/ErichStyger/mcuoneclipse.git, -directory Examples/KDS/FRDM-K64F120M/FRDM-K64F_Profiling/Profiling, commit +directory `Examples/KDS/FRDM-K64F120M/FRDM-K64F_Profiling/Profiling`, commit 9b7eedddd8b24968128582aedc63be95b61f782c, dated Mon Jan 9 16:56:17 2017 +0100. References @@ -13,11 +13,9 @@ References I recommend reading both of these to understand how the profiling code works. -[1]: https://mcuoneclipse.com/2015/08/23/tutorial-using-gnu-profiling-gprof-with-arm-cortex-m/ -"Tutorial: Using GNU Profiling (gprof) with ARM Cortex-M" +1. [Tutorial: Using GNU Profiling (gprof) with ARM Cortex-M](https://mcuoneclipse.com/2015/08/23/tutorial-using-gnu-profiling-gprof-with-arm-cortex-m/) -[2]: http://bgamari.github.io/posts/2014-10-31-semihosting.html -"Semihosting with ARM, GCC, and OpenOCD" +2. [Semihosting with ARM, GCC, and OpenOCD](http://bgamari.github.io/posts/2014-10-31-semihosting.html) How to build ------------ @@ -35,8 +33,8 @@ How to run You need to start OpenOCD on the host, and enable semihosting, at least before you try to use it as a remote file system. -I recommend executing the following in the projects/hsm directory, so that -gmon.out ends up in the same directory as hsm.elf. +I recommend executing the following in the `projects/hsm` directory, so that +`gmon.out` ends up in the same directory as `hsm.elf`. Start the debugger: @@ -60,8 +58,8 @@ whatever will be exercising the hsm. Afterwards, in the console, type `profile stop`. After invoking `profile stop`, it can take several minutes to write -gmon.out over OpenOCD to the host. +`gmon.out` over OpenOCD to the host. -In the projects/hsm directory, run gprof to analyse the gmon.out file: +In the `projects/hsm` directory, run `gprof` to analyse the `gmon.out` file: $ gprof hsm.elf >gprof.txt |