Skip to content

Commit e945738

Browse files
committed
Documentation update
1 parent 485cbc6 commit e945738

File tree

3 files changed

+2
-10
lines changed

3 files changed

+2
-10
lines changed

README.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ This document covers the installation and usage of *mbed CLI*.
3535
3. [Limiting the test scope](#limiting-the-test-scope)
3636
4. [Test directory structure](#test-directory-structure)
3737
1. [mbed CLI configuration](#mbed-cli-configuration)
38-
1. [Known limitations](#known-limitations)
3938

4039
## Installation
4140

@@ -713,9 +712,3 @@ Here is a list of currently implemented configuration settings:
713712
* `protocol` - Defines the default protocol used for importing/cloning of programs and libraries. Possible values are `https`, `http` and `ssh`. Use `ssh` if you have generated and registered SSH keys (Public Key Authentication) with a service like GitHub, GitLab, Bitbucket, etc. Read more about SSH keys [here](https://help.github.com/articles/generating-an-ssh-key/) Default: `https`.
714713
* `depth` - Defines *clone* depth for importing/cloning and applies only to *Git* repositories. Note that while this option may improve cloning speed, it may also prevent you from correctly checking out a dependency tree when the reference revision hash is older than the clone depth. Read more about shallow clones [here](https://git-scm.com/docs/git-clone). Default: none.
715714
* `cache` (EXPERIMENTAL) - Defines local path that will be used to store minimalistic copies of the imported/cloned repositories and attempt to use them to minimize traffic and speed up future importing. This feature is still under development, so this should not be used within a production environment. Default: none (disabled).
716-
717-
## Known limitations
718-
719-
<span class="warnings">**Warning**: At this point, *mbed CLI* is alpha quality and very much in development. Breakages are fully expected. Please open issues on this repository for any problems that you find with *mbed CLI*.</span>
720-
721-
* *mbed CLI* does not check whether you have Mercurial or Git installed and assumes that they are available.

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
# neo - the Morpheus Command Line Tool
1+
# mbed Command Line Interface
22

3-
*neo* is the name of the Morpheus command line tool. It enables workflows with Morpheus repositories and maintaining dependencies, code publishing and updating from remotely hosted repositories (GitHub, GitLab, mbed.org), as well as invoking Morpheus's own build system and export functions, and other operations.
3+
*mbed CLI* is the name of the ARM mbed command line tool, packaged as mbed-cli, which enables the full mbed workflow: repositories version control, maintaining dependencies, publishing code, updating from remotely hosted repositories (GitHub, GitLab and mbed.org), and invoking ARM mbed's own build system and export functions, among other operations.

docs/user_guide.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)