Skip to content

Commit 7d3140b

Browse files
committed
Documentation improvements to memap.md
- Removed installation instructions - Removed py.test instructions (not available atm) - Pointing at mbed-os tools to raise issues
1 parent d09a248 commit 7d3140b

File tree

1 file changed

+7
-36
lines changed

1 file changed

+7
-36
lines changed

docs/memap.md

Lines changed: 7 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -6,33 +6,21 @@ Note: this tool is only showing static RAM usage and the total size of allocated
66

77
## Table of Contents
88

9-
1. [Installation](#installation)
109
1. [Using memap](#using-memap)
1110
1. [Running pytest](#running-pytest)
1211
1. [Current support](#current-support)
1312
1. [Known problems](#known-problems)
1413

15-
## Installation
16-
17-
*memap* lives in https://github.com/ARMmbed/memap.
18-
19-
To get the latest version of *memap*, clone the repository and installed it:
20-
21-
```
22-
git clone https://github.com/ARMmbed/memap
23-
cd memap
24-
python setup.py install
25-
```
26-
2714
## Using memap
2815

29-
*memap* is a simple utility. These are the command line options:
16+
*memap* is a simple utility which is automatically involved after a mbed-os build.
17+
It's also possible to manually run the program with differnt command line options:
3018

3119
```
32-
$> memap
20+
$> python memap.py
3321
usage: memap-script.py [-h] -t TOOLCHAIN [-o OUTPUT] [-j] [-v] file
3422
35-
Memory Map File Analyser for ARM mbed OS version 0.3.2
23+
Memory Map File Analyser for ARM mbed OS version 0.3.7
3624
3725
positional arguments:
3826
file memory map file
@@ -51,7 +39,7 @@ optional arguments:
5139
Example:
5240

5341
```
54-
$> memap GCC_ARM\myprog3.map -t GCC_ARM
42+
$> python memap.py GCC_ARM\myprog3.map -t GCC_ARM
5543
5644
+-----------------------------------+-------+-------+------+
5745
| Module | .text | .data | .bss |
@@ -88,26 +76,9 @@ Information on memory sections:
8876
- stack: used to store local data, temporary data when branching to a subroutine and context switch info; considered dynamic allocated memory region in RAM.
8977

9078

91-
## Running pytest
92-
93-
- Run automated tests, for example:
94-
95-
```
96-
$> py.test
97-
============================= test session starts =============================
98-
platform win32 -- Python 2.7.11, pytest-2.9.1, py-1.4.31, pluggy-0.3.1
99-
rootdir: ...\memap, inifile:
100-
collected 3 items
101-
102-
test\test_memap.py ...
103-
104-
========================== 3 passed in 0.11 seconds ===========================
105-
106-
```
107-
10879
## Current support
10980

110-
*memap* has been tested on Windows 7.
81+
*memap* has been tested on Windows 7, Linux and Mac.
11182

11283
Supported map files generated by the following toolchains: gcc, ARM Compiler 5 and IAR.
11384

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

119-
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).
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.

0 commit comments

Comments
 (0)