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

Clarify the format of core:version #298

Merged
merged 1 commit into from Oct 5, 2023

Conversation

argilo
Copy link
Contributor

@argilo argilo commented Oct 2, 2023

Some of the examples in the specification use 1.0.0, while others use v1.0.0. The definition of core:version does not specify the exact format.

GNU Radio's SigMF Sink uses 1.0.0, and it's the only version accepted by IQEngine's validator, so I would assume that was intended to be the correct value.

I've updated the examples and added a clarification to the definition of core:version.

@gmabey
Copy link
Contributor

gmabey commented Oct 2, 2023

The python implementation also omits the "v" in its __init__.py (currently "1.1.3").

@gmabey
Copy link
Contributor

gmabey commented Oct 2, 2023

Not to imply that the python-sigmf version is synonymous with the version of the standard ... just a data point.

@Teque5
Copy link
Collaborator

Teque5 commented Oct 3, 2023

The most recent tag in this SigMF repo is SigMF-v1.1.0 so shouldn't it be changed in the spec to 1.1.0?

This issue is also related to #297, where I'd like to fix the tags and push a 1.2.0 release.

@argilo
Copy link
Contributor Author

argilo commented Oct 3, 2023

The most recent tag in this SigMF repo is SigMF-v1.1.0 so shouldn't it be changed in the spec to 1.1.0?

Maybe, but that seems like a separate issue that could have its own pull request. I used 1.0.0 because that's what is written everywhere in the document currently.

@argilo
Copy link
Contributor Author

argilo commented Oct 5, 2023

I updated this to explicitly state that the format is X.Y.Z.

/cc @jacobagilbert

@jacobagilbert
Copy link
Member

Thanks @argilo - I'd like to remove the "currently this is..." part though. Mostly because I don't want to need to update this every release. Reasonable? I'll get this merged.

Also, update the examples to use the correct format.
@argilo
Copy link
Contributor Author

argilo commented Oct 5, 2023

Sounds fine. Removed.

@Teque5 Teque5 merged commit affb076 into sigmf:sigmf-v1.x Oct 5, 2023
@argilo argilo deleted the clarify-version branch October 5, 2023 23:48
daniestevez added a commit to maia-sdr/maia-sdr that referenced this pull request Oct 10, 2023
According to
sigmf/SigMF#298
the SigMF version should not have a leading 'v'.

Signed-off-by: Daniel Estévez <daniel@destevez.net>
daniestevez added a commit to maia-sdr/maia-sdr that referenced this pull request Oct 11, 2023
According to
sigmf/SigMF#298
the SigMF version should not have a leading 'v'.

Signed-off-by: Daniel Estévez <daniel@destevez.net>
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

Successfully merging this pull request may close these issues.

None yet

4 participants