ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Minor changes to memap documentation

Marcelo Salazar 2016-06-07 12:32:10 +01:00
parent 7d3140b844
commit f4827b7eea
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/memap.md
View File

@ -1,6 +1,9 @@
# memap - Static Memory Map Analysis
## Introduction
*memap* is a simple command line utility useful to display static memory information required by [mbed-OS](https://github.com/ARMmbed/mbed-os) applications. This information is produced by analysing the memory map file previously generated by your toolchain.
*memap* is a simple utility useful to display static memory information required by [mbed-OS](https://github.com/ARMmbed/mbed-os) applications. This information is produced by analysing the memory map file previously generated by your toolchain.
Note: this tool is only showing static RAM usage and the total size of allocated heap and stack space, not the actual heap and stack usage.
@ -13,7 +16,7 @@ Note: this tool is only showing static RAM usage and the total size of allocated
## Using memap
*memap* is a simple utility which is automatically involved after a mbed-os build.
*memap* is a simple utility which is automatically invoked after an mbed-os build finishes succesfully.
It's also possible to manually run the program with differnt command line options:
```
@ -87,4 +90,4 @@ Supported map files generated by the following toolchains: gcc, ARM Compiler 5 a
This utility is considered 'Alpha' quality at the moment.
The report generated may not be accurate and may vary from one toolchain to another.
If you are seeing problems or would like new features to be added then please raise a ticket on [GitHub](https://github.com/ARMmbed/mbed-os/issues) and use the ```[memap] ``` in the title.
If you are seeing problems or would like new features to be added then please raise a ticket on [GitHub](https://github.com/ARMmbed/mbed-os/issues) and use ```[memap] ``` in the title.