Update documentation for memap #167
Conversation
Update version and report generated by memap Add information on how to use the depth level
There was a problem hiding this comment.
@MarceloSalazar Thanks so much. This is great. I left three suggested changes/queries for you.
docs/concepts/memap.md
Outdated
| - ``Heap``: dynamic allocations in the Heap area in RAM (for example, used by ``malloc``). The maximum size value may be defined at build time. | ||
| - ``Stack``: dynamic allocations in the Stack area in RAM (for example, used to store local data, temporary data when branching to a subroutine or context switch information). The maximum size value may be defined at build time. | ||
|
|
||
| **Note**: This tool displays static RAM and Flash usage. The heap and stack space are not included in the report as are usually configured at run time, and it's likely to change from one application to another. |
There was a problem hiding this comment.
Please change the second sentence to "The report does not include heap and stack space because they are usually configured at runtime and are likely to change from one application to another." for active voice.
docs/concepts/memap.md
Outdated
|
|
||
| ## Other useful information | ||
|
|
||
| It's possible to specify the depth value of the directory level when generating a report. By default *memap* is configured as `--depth=2`, but note that specifying `--depth=0` will display a full report. For example: |
There was a problem hiding this comment.
- Please add a comma after "default" because it's an introductory prepositional phrase.
- Please change "will display" to "displays" for consistent tense with other documentation.
docs/concepts/memap.md
Outdated
|
|
||
| ## Known issues and new features | ||
|
|
||
| This utility is considered "alpha" quality at the moment. The information generated by this utility may not be fully accurate and may vary from one toolchain to another. | ||
| The information generated by this utility may not be fully accurate and may vary from one toolchain to another. This might be caused by custom definitions of the linker scripts files or by the usage of non standard memory sections. |
There was a problem hiding this comment.
For active voice, please change this to "The information this utility generates may not be fully accurate and may vary form one toolchain to another. Custom definitions of the linker script files or usage of nonstandard memory sections may cause this variation." (Please tweak this wording if it changes the meaning.)
|
@MarceloSalazar I see the dependency PR has been merged. Does that mean this PR is now ready to merge? |
|
@AnotherButler yes please, but only when 5.5.6 gets released (in a couple of weeks) |
|
@AnotherButler please merge |
Update version and report generated by memap
Add information on how to use the depth level
Depends on memap enhancements introduced here: ARMmbed/mbed-os#4392
READY TO BE MERGED