Skip to content

Document the --stats-depth command line argument #820

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 16, 2018
Merged

Document the --stats-depth command line argument #820

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
394d933
Document the `--stats-depth` command line argument
theotherjimmy Nov 7, 2018
7687eb8
Edit addition to cli-compile.md
Nov 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/tools/CLI/cli-compile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>` 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`.
- `--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.
- `--library` compiles the code as a [static `.a/.ar` library](#compiling-static-libraries).
- `--no-archive` suppresses the creation of `.a/.ar` files created by `--library`, producing many `.o` files instead.
Expand Down