Skip to content

Commit b3df663

Browse files
iriark01jainvikas8
authored andcommitted
Links and redirects
1 parent d1934eb commit b3df663

File tree

11 files changed

+18
-17
lines changed

11 files changed

+18
-17
lines changed

docs/debugging-testing/debug/vs_code.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This document explains how to build and debug Arm Mbed OS applications using Visual Studio Code. Before starting, first [configure your local debug toolchain](../debug-test/setting-up-a-local-debug-toolchain.html).
44

5-
Also install [GNU Make](https://www.gnu.org/software/make/) or [Mbed CLI](../build-tools/mbed-cli.html) to build the project.
5+
Also install [GNU Make](https://www.gnu.org/software/make/) or [Mbed CLI](../build-tools/mbed_cli_1) to build the project.
66

77
## Installing Visual Studio Code
88

docs/debugging-testing/testing/testing_greentea.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ A test case is named by its position in your project's file structure. For insta
5858

5959
### Building tests
6060

61-
You can build tests through Arm Mbed CLI. For information on using Mbed CLI, please see the [CLI documentation](../build-tools/mbed-cli.html).
61+
You can build tests through Arm Mbed CLI. For information on using Mbed CLI, please see the [CLI documentation](../build-tools/mbed_cli_1).
6262

6363
When you build tests for a target and a toolchain, the script first discovers the available tests and then builds them in parallel. You can also create a **test specification** file, which our testing tools can use to run automated hardware tests. For more information on the test specification file, please see the [Greentea documentation](https://github.com/ARMmbed/mbed-os-tools/tree/master/packages/mbed-greentea#test-specification-json-formatted-input).
6464

docs/debugging-testing/testing/unit_testing.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Detailed instructions for supported operating systems are below.
3030
sudo easy_install pip
3131
```
3232

33-
1. Install Gcovr and [Mbed CLI](../build-tools/mbed-cli.html) with `pip install "gcovr>=4.1" mbed-cli`.
33+
1. Install Gcovr and [Mbed CLI](../build-tools/mbed_cli_1) with `pip install "gcovr>=4.1" mbed-cli`.
3434

3535
### Installing dependencies on macOS
3636

@@ -46,7 +46,7 @@ In a terminal window:
4646
sudo easy_install pip
4747
```
4848

49-
1. Install Gcovr and [Mbed CLI](../build-tools/mbed-cli.html) with `pip install "gcovr>=4.1" mbed-cli`.
49+
1. Install Gcovr and [Mbed CLI](../build-tools/mbed_cli_1) with `pip install "gcovr>=4.1" mbed-cli`.
5050
1. (Optional) Install GCC with `brew install gcc`.
5151

5252
### Installing dependencies on Windows
@@ -57,7 +57,7 @@ In a terminal window:
5757
1. Download CMake binaries from https://cmake.org/download/, and run the installer.
5858
1. Download Python 2.7 or Python 3 from https://www.python.org/getit/, and run the installer.
5959
1. Add MinGW, CMake and Python into system PATH.
60-
1. Install Gcovr and [Mbed CLI](../build-tools/mbed-cli.html) with `pip install "gcovr>=4.1" mbed-cli`.
60+
1. Install Gcovr and [Mbed CLI](../build-tools/mbed_cli_1) with `pip install "gcovr>=4.1" mbed-cli`.
6161

6262
## Test code structure
6363

docs/introduction/terms.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
**Application** - An executable software module built out of libraries that acts as a final product.
88

9-
**Arm Mbed CLI** - The name of the Arm Mbed [command-line tool](../build-tools/mbed-cli.html), packaged as `mbed-cli`.
9+
**Arm Mbed CLI** - The name of the Arm Mbed [command-line tool](../build-tools/mbed_cli_1), packaged as `mbed-cli`.
1010

1111
**Arm Mbed interface** - The extra chip that sits on all [Mbed Enabled development boards](index.html). It's what makes the target chip (for example, K64F) look like a USB drive. It usually runs a separate piece of software that generally doesn't change. That software is usually `DAPLink`, `CMSIS-DAP` or `STLink`.
1212

docs/program-setup/build-profiles-rules/debug_builds_cli.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<h1 id="debug-builds-cli">Debug builds</h1>
22

3-
After you've set up your [local debug toolchain](../program-setup/build-profiles-and-rules.html), you need firmware that includes program symbols (an `.elf` file). Because the Arm Mbed Online Compiler only produces binaries that omit the program symbols, you need to compile locally using [Arm Mbed CLI](../build-tools/mbed-cli.html).
3+
After you've set up your [local debug toolchain](../program-setup/build-profiles-and-rules.html), you need firmware that includes program symbols (an `.elf` file). Because the Arm Mbed Online Compiler only produces binaries that omit the program symbols, you need to compile locally using [Arm Mbed CLI](../build-tools/mbed_cli_1).
44

55
<span class="notes">**Note:** Make sure to do a clean build when switching to and from debug and release by removing the `BUILD` folder.</span>
66

docs/program-setup/mbed_targets.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Arm Mbed uses JSON as a description language for its build targets. You can find the JSON description of Mbed targets in `targets/targets.json` and in `custom_targets.json` in the root of a project directory. If you provide a source directory using the `--source` switch, Mbed looks for `custom_targets.json` in that directory instead. When you add new targets with `custom_targets.json`, they are added to the list of available targets, in addition to the [scanning rules](../program-setup/build-rules.html).
44

5-
<span class="notes">**Note:** The Online Compiler does not support this functionality. You need to use [Mbed CLI](../build-tools/mbed-cli.html) to take your code offline.</span>
5+
<span class="notes">**Note:** The Online Compiler does not support this functionality. You need to use [Mbed CLI](../build-tools/mbed_cli_1) to take your code offline.</span>
66

77
You are not allowed to redefine existing targets in `custom_targets.json`. To better understand how a target is defined, we'll use this example (taken from `targets.json`):
88

@@ -431,5 +431,5 @@ The `orphans` command shows all targets that you cannot reach from a public targ
431431
## Related content
432432

433433
- [Defining a PSA-compliant target in targets.json](../program-setup/adding-and-configuring-targets.html#defining-a-psa-compliant-target-in-targets.json).
434-
- [Developing: Mbed CLI](../build-tools/mbed-cli.html).
434+
- [Developing: Mbed CLI](../build-tools/mbed_cli_1).
435435
- [Custom targets in Mbed Studio](https://os.mbed.com/docs/mbed-studio/current/mbed-os/custom-targets.html).

docs/quick-start/cli_setting_up.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h1 id="cli-setup">Installing Mbed CLI</h1>
1+
<h1 id="cli-setup">Installing Mbed CLI 1</h1>
22

33
The setup process for Arm Mbed CLI depends on your operating system. We recommend using our installers, but have also provided links to manual installation instructions.
44

docs/quick-start/quick-start.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ The quick start offers two versions of Blinky: the full profile version and the
88

99
## Please choose how to proceed
1010

11-
| [Build with Mbed Studio](https://os.mbed.com/docs/mbed-studio/current/getting-started/index.html) | [Build with Mbed Online Compiler](../quick-start/build-with-the-online-compiler.html) | [Build with Mbed CLI](../quick-start/build-with-mbed-cli.html) |
11+
| [Build with Mbed Studio](https://os.mbed.com/docs/mbed-studio/current/getting-started/index.html) | [Build with Mbed Online Compiler](../quick-start/build-with-the-online-compiler.html) | [Build with Mbed CLI 1](../quick-start/build-with-mbed-cli.html) |
1212
| --- | --- | --- |
13-
|Download our dedicated desktop IDE, including all the necessary tools to work with Mbed OS.<br> This link will take you to the Mbed Studio documentation site. | Zero-installation web IDE to explore Mbed OS; great for rapid prototyping and education. | Command-line tool requiring manual setup of tools, but providing the greatest degree of flexibility. |
13+
|Download our dedicated desktop IDE, including all the necessary tools to work with Mbed OS.<br> This link will take you to the Mbed Studio documentation site. | Zero-installation web IDE to explore Mbed OS; great for rapid prototyping and education. | Command-line tool requiring manual setup, but providing the greatest degree of flexibility. |
1414

1515
Once you have this application working, check the [further reading section](../quick-start/further-reading.html) to add functionality.

docs/tools/mbed_cli_2/use.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ To perform an iterative build on a previously configured project:
178178
mbed-tools build
179179
```
180180
181-
## List library dependencies of an application
181+
## List an application's library dependencies
182182
183183
To list all library dependencies with their URL and Git reference:
184184

docs/tools/toolchains/export_to_third_party.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The export process generates a ZIP archive with a project file matching your sel
2828

2929
## Exporting from Arm Mbed CLI
3030

31-
[Mbed CLI](../build-tools/mbed-cli.html) currently supports [exporting](../build-tools/third-party-build-tools.html#exporting-from-arm-mbed-cli) to all of the development environments mentioned above by using the `export` command.
31+
[Mbed CLI](../build-tools/mbed_cli_1) currently supports [exporting](../build-tools/third-party-build-tools.html#exporting-from-arm-mbed-cli) to all of the development environments mentioned above by using the `export` command.
3232

3333
For example, to export to uVision5 with the K64F target, run:
3434

redirects.json

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"reference/mesh-tech.html": "apis/6LoWPAN-ND-tech.html",
3-
"tools/developing-arm-mbed-cli.html": "build-tools/mbed-cli.html",
3+
"tools/developing-arm-mbed-cli.html": "build-tools/mbed-cli-1.html",
44
"tools/windows.html": "build-tools/install-and-set-up.html",
55
"tools/macos.html": "build-tools/install-and-set-up.html",
66
"tools/linux.html": "build-tools/install-and-set-up.html",
@@ -170,11 +170,12 @@
170170
"apis/batteryservice.html" : "apis/bluetooth-apis.html",
171171
"apis/messagebuilder.html" : "apis/nfc-apis.html",
172172
"reference/using-small-c-libraries.html" : "bare-metal/using-small-c-libraries.html",
173-
"tools/developing-mbed-cli.html" : "build-tools/mbed-cli.html",
173+
"tools/developing-mbed-cli.html" : "build-tools/mbed-cli-1.html",
174174
"apis/using-mbed-tls-to-communicate-securely.html" : "apis/tls-tutorial.html",
175175
"introduction/how-we-release-arm-mbed-os.html" : "introduction/versions-and-releases.html",
176176
"apis/quadspi.html" : "apis/spi-apis.html",
177177
"apis/mesh.html" : "apis/mesh-api.html",
178178
"apis/dns.html" : "apis/dns-apis.html",
179-
"porting/psa-compliance-port.html" : "porting/porting-security.html"
179+
"porting/psa-compliance-port.html" : "porting/porting-security.html",
180+
"build-tools/mbed-cli.html" : "build-tools/mbed-cli-1.html"
180181
}

0 commit comments

Comments
 (0)