Skip to content

Commit f4827b7

Browse files
committed
Minor changes to memap documentation
1 parent 7d3140b commit f4827b7

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

docs/memap.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1+
2+
# memap - Static Memory Map Analysis
3+
14
## Introduction
25

3-
*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.
6+
*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.
47

58
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.
69

@@ -13,7 +16,7 @@ Note: this tool is only showing static RAM usage and the total size of allocated
1316

1417
## Using memap
1518

16-
*memap* is a simple utility which is automatically involved after a mbed-os build.
19+
*memap* is a simple utility which is automatically invoked after an mbed-os build finishes succesfully.
1720
It's also possible to manually run the program with differnt command line options:
1821

1922
```
@@ -87,4 +90,4 @@ Supported map files generated by the following toolchains: gcc, ARM Compiler 5 a
8790
This utility is considered 'Alpha' quality at the moment.
8891
The report generated may not be accurate and may vary from one toolchain to another.
8992

90-
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.
93+
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.

0 commit comments

Comments
 (0)