Skip to content

Commit 9fa3dd1

Browse files
authored
[docs] Align pack name convention documentation with schema
1 parent b6b4f1b commit 9fa3dd1

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

docs/YML-Input-Format.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,16 @@ File Extension | [Category](https://open-cmsis-pack.github.io/Open-CMS
2929
The **`csolution` Project Manager** uses the following syntax to specify the `pack:` names in the `*.yml` files.
3030

3131
```yml
32-
[vendor ::] pack-name # Use the latest version of the pack
33-
[vendor ::] pack-name@version # With exact version
34-
[vendor ::] pack-name@>=version # With version equal or higher
35-
[vendor ::] pack-name@^version # With version equal or higher but the same major version
36-
[vendor ::] pack-name@~version # With version equal or higher but the same major and minor version
32+
vendor::pack-name # Use the latest version of the pack
33+
vendor::pack-name@version # With exact version
34+
vendor::pack-name@>=version # With version equal or higher
35+
vendor::pack-name@^version # With version equal or higher but the same major version
36+
vendor::pack-name@~version # With version equal or higher but the same major and minor version
3737
```
3838

3939
Element | | Description
4040
:------------|--------------|:---------------------
41-
`vendor` | Optional | Vendor name of the software pack.
41+
`vendor` | **Required** | Vendor name of the software pack.
4242
`pack-name` | **Required** | Name of the software pack; wildcards (\*, ?) can be used.
4343
`@version` | Optional | Software pack version number must exactly match, i.e. `@1.2.3`
4444
`@>=version` | Optional | Automatically update to any version higher or equal.
@@ -53,13 +53,13 @@ Element | | Description
5353
**Examples:**
5454

5555
```yml
56-
- pack: ARM::[email protected] # 'CMSIS' Pack with version 5.5.0
57-
- pack: MDK-Middleware@>=7.13.0 # latest version 7.13.0 or higher
58-
- pack: MDK-Middleware@^7.13.0 # latest version 7.13.0 or higher, but lower than 8.0.0
59-
- pack: Keil::TFM # 'TFM' Pack from vendor Keil, latest installed version
60-
- pack: AWS # All Software Packs from vendor 'AWS', latest version
61-
- pack: Keil::STM* # Software Packs that start with 'STM' from vendor 'Keil'
62-
- pack: MDK-Middleware@>=8.0.0-0 # version 8.0.0 or higher including pre-release versions
56+
- pack: ARM::[email protected] # 'CMSIS' Pack with version 5.5.0
57+
- pack: Keil::MDK-Middleware@>=7.13.0 # latest version 7.13.0 or higher
58+
- pack: Keil::MDK-Middleware@^7.13.0 # latest version 7.13.0 or higher, but lower than 8.0.0
59+
- pack: Keil::TFM # 'TFM' Pack from vendor Keil, latest installed version
60+
- pack: AWS # All Software Packs from vendor 'AWS', latest version
61+
- pack: Keil::STM* # Software Packs that start with 'STM' from vendor 'Keil'
62+
- pack: Keil::MDK-Middleware@>=8.0.0-0 # version 8.0.0 or higher including pre-release versions
6363
```
6464
6565
### `component:` Name Conventions

0 commit comments

Comments
 (0)