Skip to content

Commit c567c97

Browse files
committed
Consistantify --profile useage
1 parent 1994b23 commit c567c97

File tree

6 files changed

+11
-11
lines changed

6 files changed

+11
-11
lines changed

docs/tools/CLI/cli-compile.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +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.
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-
- `--profile <PATH_TO_BUILD_PROFILE>` selects a path to a build profile configuration file. Example: `mbed-os/tools/profiles/debug.json`. See the dedicated [build profile documentation](/docs/tools/CLI/build_profiles.html) for more detail.
45+
- `--profile <PATH_TO_BUILD_PROFILE>` selects a path to a build profile configuration file. Example: `debug`. See the dedicated [build profile documentation](/docs/tools/CLI/build_profiles.html) for more detail.
4646
- `--library` compiles the code as a [static `.a/.ar` library](#compiling-static-libraries).
4747
- `--no-archive` suppresses the creation of `.a/.ar` files created by `--library`, producing many `.o` files instead.
4848
<span class="notes">**Note**: This option does nothing without `--library`.</span>
@@ -128,10 +128,10 @@ $ mbed compile -t GCC_ARM -m K64F -c -DUVISOR_PRESENT
128128

129129
##### Compile in debug mode
130130

131-
To compile in debug mode (as opposed to the default *develop* mode), use `--profile mbed-os/tools/profiles/debug.json` in the compile command-line:
131+
To compile in debug mode (as opposed to the default *develop* mode), use `--profile debug` in the compile command-line:
132132

133133
```
134-
$ mbed compile -t GCC_ARM -m K64F --profile mbed-os/tools/profiles/debug.json
134+
$ mbed compile -t GCC_ARM -m K64F --profile debug
135135
```
136136

137137

docs/tools/CLI/debug_builds_cli.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,19 @@ $ mbed compile -o debug-info
2121
**Arm Mbed 2.0**
2222

2323
```
24-
$ mbed compile --profile .temp/tools/profiles/debug.json
24+
$ mbed compile --profile debug
2525
```
2626

2727
### Exporting with debug symbols
2828

2929
You can also enable debug symbols when [exporting your project](exporting.html) by using:
3030

3131
```
32-
$ mbed export -i uvision -m K64F --profile mbed-os/tools/profiles/debug.json
32+
$ mbed export -i uvision -m K64F --profile debug
3333
```
3434

3535
Make release builds by using:
3636

3737
```
38-
$ mbed export -i uvision -m K64F --profile mbed-os/tools/profiles/default.json
38+
$ mbed export -i uvision -m K64F --profile release
3939
```

docs/tools/debug/debug_intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ In your project folder, run:
2424
# alternatively, use -i make_armc5 for ARMCC, or -i make_iar for IAR
2525
# replace K64F with your target board
2626
27-
$ mbed export -i make_gcc_arm -m K64F --profile mbed-os/tools/profiles/debug.json
27+
$ mbed export -i make_gcc_arm -m K64F
2828
```
2929

3030
##### Serial terminal

docs/tutorials/debug/eclipse_pyocd.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ In your project folder, run:
4343
# Replace K64F with your target board
4444
# If you're not using GCC ARM, use -i eclipse_armc5 for ARMCC, or -i eclipse_iar for IAR
4545
46-
$ mbed export -i eclipse_gcc_arm -m K64F --profile mbed-os/tools/profiles/debug.json
46+
$ mbed export -i eclipse_gcc_arm -m K64F --profile debug
4747
```
4848

4949
### Importing the project in Eclipse
@@ -121,5 +121,5 @@ We build using Make, but you can also use Mbed CLI for building from Eclipse:
121121
1. Go to *Project > Properties > C/C++ Build*.
122122
1. Remove the check *Use default build command*.
123123
1. Set *Build command* to `mbed`.
124-
1. Under *Behavior* > *Build (Incremental build)*, select your Mbed CLI build options. For example: `compile -m K64F -t GCC_ARM --profile ${CWD}mbed-os/tools/profiles/debug.json`.
124+
1. Under *Behavior* > *Build (Incremental build)*, select your Mbed CLI build options. For example: `compile -m K64F -t GCC_ARM --profile debug`.
125125
1. Make sure to update the paths to the `.elf` file in your debug configuration.

docs/tutorials/debug/keil_uvision.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ To export your project to uVision, you can use either the Online Compiler or Mbe
2323

2424
```
2525
# replace K64F with your target board
26-
$ mbed export -i uvision5 -m K64F --profile mbed-os/tools/profiles/debug.json
26+
$ mbed export -i uvision5 -m K64F
2727
```
2828
2929
### Starting a debug session

docs/tutorials/debug/vs_code.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ In your project folder, run:
4040
# alternatively, use -i vscode_armc5 for ARMCC, or -i vscode_iar for IAR
4141
# replace K64F with your target board
4242
43-
$ mbed export -i vscode_gcc_arm -m K64F --profile mbed-os/tools/profiles/debug.json
43+
$ mbed export -i vscode_gcc_arm -m K64F --profile debug
4444
```
4545

4646
### Configuring the debugger

0 commit comments

Comments
 (0)