3party/vcpkg
0
0
Fork 0
mirror of https://github.com/microsoft/vcpkg.git synced 2024-12-28 19:25:27 +08:00
Code Issues Projects Releases Wiki Activity

[doc] Update manifest to reference versioning spec (#17549)

Browse Source 
* Update manifest to reference versioning spec

Currently only `version-string` is included in the manifest-files.md. However there are more variants of this field. This PR adds a cross link to the versioning specification. 

fixes #17548

* move version field up

* list different version schemes

* remove comma

* Update docs/maintainers/manifest-files.md

Co-authored-by: NancyLi1013 <46708020+NancyLi1013@users.noreply.github.com>

Co-authored-by: NancyLi1013 <46708020+NancyLi1013@users.noreply.github.com>
This commit is contained in:
Mathis Logemann 2021-04-29 22:48:55 +02:00 committed by GitHub
parent 713e3aeb3f
commit 4de6cd5ed8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/maintainers/manifest-files.md
View File

@ -69,9 +69,18 @@ numbers, and hyphens, and it must not begin nor end with a hyphen.
### Version fields ### Version fields
The library version. There is currently only one kind of version, a `"version-string"` - Currently there are different fields for special versioning. Namely:
however, more version kinds will be added later. Additionally,
`"port-version"` is used to differentiate between port changes that don't change the underlying library version. Manifest property | Versioning scheme
------------------|------------------------------------
`version` | For dot-separated numeric versions
`version-semver` | For SemVer compliant versions
`version-date` | For dates in the format YYYY-MM-DD
`version-string` | For arbitrary strings
See https://github.com/microsoft/vcpkg/blob/master/docs/specifications/versioning.md#22-package-versions for more details.
Additionally, `"port-version"` is used to differentiate between port changes that don't change the underlying library version.
#### `"version-string"` #### `"version-string"`