Document the --stats-depth command line argument
#820
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The code that implements this has been in master for a yearish
|
@sg- @linlingao Outcome of our discussion. |
linlingao
reviewed
Nov 7, 2018
docs/tools/CLI/cli-compile.md
Outdated
| @@ -42,6 +42,7 @@ The arguments for *compile* are: | |||
| - `--source <SOURCE>` selects the source directory. The default is `.` (the current directory). You can specify multiple source locations, even outside the program tree. Find more details about the `--source` switch in the [build rules documentation](/docs/development/tools/mbed-os-build-rules.html). | |||
| - `--build <BUILD>` selects the build directory. Default: `BUILD/` inside your program root. | |||
| <span class="notes">**Note**: `mbed compile` ignores the current build directory; creating multiple build directories leads to errors.</span> | |||
| - `--stats-depth <DEPTH>` summarize memory statistics within the table printed after linking, the CSV map file and the JSON map file for paths with depth greater than `DEPTH`. Default: `2`. | |||
There was a problem hiding this comment.
Should be "summarizes" to be consistent with others.
Fix agreement error/typo.
AnotherButler
approved these changes
Nov 16, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The code that implements this has been in master for a yearish