Skip to content

Commit f1db9ac

Browse files
committed
Documentation improvements
1 parent 18421e9 commit f1db9ac

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -165,15 +165,15 @@ Use `mbed ls` to list all the libraries imported to your program:
165165
$ cd mbed-os-program
166166
$ mbed ls
167167
mbed-os-program (no revision)
168-
`- mbed-os (#182bbd51bc8d, tags:latest, mbed-os-5.6.5)
168+
`- mbed-os (#182bbd51bc8d, tags: latest, mbed-os-5.6.5)
169169
```
170170

171171
Use `mbed releases` to list all releases in a program or library:
172172

173173
```
174174
$ cd mbed-os
175175
$ mbed releases
176-
mbed-os (#182bbd51bc8d, tags:latest, mbed-os-5.6.5)
176+
mbed-os (#182bbd51bc8d, tags: latest, mbed-os-5.6.5)
177177
...
178178
* mbed-os-5.6.0
179179
* mbed-os-5.6.1
@@ -702,7 +702,7 @@ Let's assume that the list of dependencies of your program (obtained by running
702702

703703
```
704704
my-mbed-os-example (#a5ac4bf2e468)
705-
|- mbed-os (#182bbd51bc8d, tags:latest, mbed-os-5.6.5)
705+
|- mbed-os (#182bbd51bc8d, tags: latest, mbed-os-5.6.5)
706706
`- my-libs (#e39199afa2da)
707707
|- my-libs/iot-client (#571cfef17dd0)
708708
`- my-libs/test-framework (#cd18b5a50df4)
@@ -756,14 +756,14 @@ The update command fails if there are changes in your program or library that `m
756756

757757
### Updating to an upstream version
758758

759-
Before updating a program or a library, it's good to know the names of the stable releases, usually marked with a tag using a common format, such as `1.2`, `v1.0.1`, `r5.6`, `mbed-os-5.6` and so on.
759+
Before updating a program or a library, it's good to know the names of the stable releases, usually marked with a tag using a common format, such as `1.2`, `v1.0.1`, `r5.6`, `mbed-os-5.6` and so on.
760760

761761
You can find stable release versions of a program or a library using the `mbed releases` command:
762762

763763
```
764764
$ cd mbed-os
765765
$ mbed releases
766-
mbed-os (#182bbd51bc8d, tags:latest, mbed-os-5.6.5)
766+
mbed-os (#182bbd51bc8d, tags: latest, mbed-os-5.6.5)
767767
...
768768
* mbed-os-5.6.0
769769
* mbed-os-5.6.1
@@ -780,7 +780,7 @@ Lastly, you can list unstable releases, such as release candidates, alphas and b
780780
```
781781
$ cd mbed-client
782782
$ mbed releases -u
783-
mbed-client (#31e5ce203cc0, tags:v3.0.0)
783+
mbed-client (#31e5ce203cc0, tags: v3.0.0)
784784
* mbed-os-5.0-rc1
785785
* mbed-os-5.0-rc2
786786
* r0.5-rc4
@@ -792,6 +792,8 @@ mbed-client (#31e5ce203cc0, tags:v3.0.0)
792792

793793
You can use the `-a` switch to print release and revision hash pairs.
794794

795+
Mbed CLI recognizes stable release if the tags are in standard versioning format, such as `MAJOR[.MINOR][.PATCH][.BUILD]`, and optionally prefixed with either `v`, `r` or `mbed-os`. Unstable releases can be suffixed with any letter/number/hyphen/dot combination.
796+
795797
#### Updating a program
796798

797799
To update your program to another upstream version, go to the root folder of the program, and run:

0 commit comments

Comments
 (0)