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

Incomplete documentation about spec versioning #551

Open
vmalia opened this issue Jun 27, 2024 · 2 comments
Open

Incomplete documentation about spec versioning #551

vmalia opened this issue Jun 27, 2024 · 2 comments

Comments

@vmalia
Copy link
Contributor

vmalia commented Jun 27, 2024

Description

We recently had a customer request to provide APIs in Intel(R) oneMKL, for providing the version of the oneAPI spec that the product is compliant with.

During this investigation, I found that the oneAPI spec repository uses https://github.com/uxlfoundation/oneAPI-spec/blob/main/oneapi-doc.json file to define a version string, but the specification itself does not have any guidelines about when to rename the specification's major or minor version.

Expected

  1. The spec should define what a major and minor version update mean for the specification and the underlying product. Same for the revision.
  2. The versioning scheme must be programmatically possible to implement, similar to semantic versioning.
@rscohn2
Copy link
Member

rscohn2 commented Jun 27, 2024

@vmalia
Copy link
Contributor Author

vmalia commented Jul 9, 2024

Thank you @rscohn2 . This addresses my first concern, but not the second.

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