Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Inconsistency definition of "version" field in vcpkg.json #303

Open
bansan85 opened this issue Apr 4, 2024 · 0 comments
Open

Inconsistency definition of "version" field in vcpkg.json #303

bansan85 opened this issue Apr 4, 2024 · 0 comments
Assignees

Comments

@bansan85
Copy link
Contributor

bansan85 commented Apr 4, 2024

  • In vcpkg/reference/vcpkg-json.md, you can read:

"version" - Relaxed Semantic Version 2.0.0, allowing more or less than 3 primary numbers. Example: 1.2.3.4.10-alpha1

  • In vcpkg/users/versioning.md, you can read:
  1. version: For dot-separated numeric versions

and

  1. version

Accepts version strings that follow a relaxed, dot-separated-, semver-like scheme.

The version is logically composed of dot-separated (.) numeric sections. Each section must contain an integer positive number with no leading zeroes.

The regex pattern for this versioning scheme is: (0|[1-9]\d*)(.(0|[1-9]\d*))*

  • Inconsistency

I think the documentation in vcpkg-json.md is good.

The regex in versioning.md looks to be wrong. This sentence should be removed to avoid confusion.

The sentence "For dot-separated numeric versions" also looks to be wrong.

The version comparison in versioning.md should also be updated to avoid thinking that "version" allow only number. For example (see the two last version updated) :

1.0.0-1 < 1.0.0-alpha < 1.0.0-beta < 1.0.0 < 1.0.1+20240101 < 1.1.0.0-alpha

@vicroms vicroms self-assigned this Apr 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants