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

Documentation improvements to memap.md 

- Removed installation instructions
- Removed py.test instructions (not available atm)
- Pointing at mbed-os tools to raise issues
Marcelo Salazar 2016-06-07 12:19:06 +01:00
parent d09a24835e
commit 7d3140b844
1 changed files with 7 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
docs/memap.md
View File

@ -6,33 +6,21 @@ Note: this tool is only showing static RAM usage and the total size of allocated
## Table of Contents ## Table of Contents
1. [Installation](#installation)
1. [Using memap](#using-memap) 1. [Using memap](#using-memap)
1. [Running pytest](#running-pytest) 1. [Running pytest](#running-pytest)
1. [Current support](#current-support) 1. [Current support](#current-support)
1. [Known problems](#known-problems) 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 ## 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 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: positional arguments:
file memory map file file memory map file
@ -51,7 +39,7 @@ optional arguments:
Example: Example:
``` ```
$> memap GCC_ARM\myprog3.map -t GCC_ARM $> python memap.py GCC_ARM\myprog3.map -t GCC_ARM
+-----------------------------------+-------+-------+------+ +-----------------------------------+-------+-------+------+
| Module | .text | .data | .bss | | 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. - 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 ## 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. 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. This utility is considered 'Alpha' quality at the moment.
The report generated may not be accurate and may vary from one toolchain to another. 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.