ARMmbed / ARMmbed/mbed-cli

mbed new --scm=none

Open
#959 1 comment 0 reactions 0 assignees View on GitHub
Jira status: OPEN mirrored type: bug
Dominant language
Python
Stars
339
Forks
187
PR merge metrics
No merged PRs in 30d

Description

This is merely a matter of documentation:
whereas in docs of new command, we read, that --scm may apply values
- git (default),
- hg, or
- bld (never heared of that),
code shows that also value none is allowed.

Value none is important if mbed new shall create a program which is within a more comprehensive git project. The value none really occurs in the code and so it shall be documented in the help.
Also i feel that in the internet site
https://os.mbed.com/docs/mbed-os/v5.15/tools/working-with-mbed-cli.html
this value shall be mentioned,
as the application case is important.

Maybe also a good idea to document --scm more generally:
what blk is and that hg and git can be used transparently.

Another aspect: it is not ```mbed new --scm none .``` but it is ```mbed new --scm=none .```
which should also be reflected in the documentation.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.