diff options
| author | Mathis Logemann <mathisloge@gmail.com> | 2021-04-29 22:48:55 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-04-29 13:48:55 -0700 |
| commit | 4de6cd5ed8fe28f479818758864b6e84e35a3cd8 (patch) | |
| tree | 173fbfa415c23ea647d4b522a6a387ac34f0185b /docs | |
| parent | 713e3aeb3f04a2ef9a1df3c411f937e2dbcdb875 (diff) | |
| download | vcpkg-4de6cd5ed8fe28f479818758864b6e84e35a3cd8.tar.gz vcpkg-4de6cd5ed8fe28f479818758864b6e84e35a3cd8.zip | |
[doc] Update manifest to reference versioning spec (#17549)
* 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>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/maintainers/manifest-files.md | 15 |
1 files changed, 12 insertions, 3 deletions
diff --git a/docs/maintainers/manifest-files.md b/docs/maintainers/manifest-files.md index 3e79aa08a..f90d6ccbe 100644 --- a/docs/maintainers/manifest-files.md +++ b/docs/maintainers/manifest-files.md @@ -69,9 +69,18 @@ numbers, and hyphens, and it must not begin nor end with a hyphen. ### Version fields -The library version. There is currently only one kind of version, a `"version-string"` - -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. +Currently there are different fields for special versioning. Namely: + +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"` |