Improve documentation (0.8) #237
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Jun 29, 2016
Closed
…bort (Ctrl+C) as error
| * `toolchain` - Defines default toolchain for `compile` and `test` can be set through `mbed toolchain`. Default: none. | ||
| * `ARM_PATH`, `GCC_ARM_PATH`, `IAR_PATH` - defines default path to ARM Compiler, GCC ARM and IAR Workbench toolchains. Default: none. | ||
| * `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`. | ||
| * `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 older than the clone depth. Google `shallow clone` if you'd like to know more about using shallow clones. Default: none. |
There was a problem hiding this comment.
Nit pick 1:
it may also prevent you from correctly checking out a dependency tree when the reference revision hash older than the clone depth
Add "is" here:
it may also prevent you from correctly checking out a dependency tree when the reference revision hash is older than the clone depth
Nit pick 2: Let's not tell them to "Google" shallow clone. Instead maybe we should link them directly to the git clone documentation page here: https://git-scm.com/docs/git-clone
|
Added a few notes. +1 for docs! |
|
LGTM 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add mbed CLI configuration section to README