Skip to content

Commit 3391dcc

Browse files
author
Amanda Butler
authored
Merge pull request #820 from theotherjimmy/doc-stats-depth
Document the `--stats-depth` command line argument
2 parents 2971803 + 7687eb8 commit 3391dcc

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

docs/tools/CLI/cli-compile.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ The arguments for *compile* are:
4242
- `--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).
4343
- `--build <BUILD>` selects the build directory. Default: `BUILD/` inside your program root.
4444
<span class="notes">**Note**: `mbed compile` ignores the current build directory; creating multiple build directories leads to errors.</span>
45+
- `--stats-depth <DEPTH>` summarizes 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`.
4546
- `--profile <PATH_TO_BUILD_PROFILE>` selects a path to a build profile configuration file. Example: `debug`. See the dedicated [build profile documentation](/docs/development/tools/CLI/build-profiles.html) for more detail.
4647
- `--library` compiles the code as a [static `.a/.ar` library](#compiling-static-libraries).
4748
- `--no-archive` suppresses the creation of `.a/.ar` files created by `--library`, producing many `.o` files instead.

0 commit comments

Comments
 (0)