diff --git a/docs/memap.md b/docs/memap.md index 2da36b2574..5e3241a885 100644 --- a/docs/memap.md +++ b/docs/memap.md @@ -6,33 +6,21 @@ Note: this tool is only showing static RAM usage and the total size of allocated ## Table of Contents -1. [Installation](#installation) 1. [Using memap](#using-memap) 1. [Running pytest](#running-pytest) 1. [Current support](#current-support) 1. [Known problems](#known-problems) -## Installation - -*memap* lives in https://github.com/ARMmbed/memap. - -To get the latest version of *memap*, clone the repository and installed it: - -``` -git clone https://github.com/ARMmbed/memap -cd memap -python setup.py install -``` - ## Using memap -*memap* is a simple utility. These are the command line options: +*memap* is a simple utility which is automatically involved after a mbed-os build. +It's also possible to manually run the program with differnt command line options: ``` -$> memap +$> python memap.py usage: memap-script.py [-h] -t TOOLCHAIN [-o OUTPUT] [-j] [-v] file -Memory Map File Analyser for ARM mbed OS version 0.3.2 +Memory Map File Analyser for ARM mbed OS version 0.3.7 positional arguments: file memory map file @@ -51,7 +39,7 @@ optional arguments: Example: ``` -$> memap GCC_ARM\myprog3.map -t GCC_ARM +$> python memap.py GCC_ARM\myprog3.map -t GCC_ARM +-----------------------------------+-------+-------+------+ | Module | .text | .data | .bss | @@ -88,26 +76,9 @@ Information on memory sections: - stack: used to store local data, temporary data when branching to a subroutine and context switch info; considered dynamic allocated memory region in RAM. -## Running pytest - -- Run automated tests, for example: - -``` -$> py.test -============================= test session starts ============================= -platform win32 -- Python 2.7.11, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 -rootdir: ...\memap, inifile: -collected 3 items - -test\test_memap.py ... - -========================== 3 passed in 0.11 seconds =========================== - -``` - ## Current support -*memap* has been tested on Windows 7. +*memap* has been tested on Windows 7, Linux and Mac. Supported map files generated by the following toolchains: gcc, ARM Compiler 5 and IAR. @@ -116,4 +87,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/memap/issues). +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.