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

Minor adjustments to the documentation for the JSON schema version #76

Merged
merged 1 commit into from
Sep 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ changed, we will also update the schema version number. The version number is
represented as a single integer. Any changes to the schema are assumed to be
backwards-incompatible with previous versions of the schema, so all version
bumps should be treated as major version bumps. Each change to the schema is
described in the [`SCHEMA_VERSIONING.md`](SCHEMA_VERSIONING.md) file.
described in the [`SCHEMA_CHANGELOG.md`](SCHEMA_CHANGELOG.md) file.


[crux-mir-repo]: https://github.com/GaloisInc/crucible/tree/master/crux-mir
11 changes: 10 additions & 1 deletion SCHEMA_CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,13 @@ versioned separately.)

## 1

Initial schema version.
Initial schema version, as of 20240910.

## Unversioned files prior to version 1

The schema used between 20240823 and 20240910 is the same as version
1, except without the version tag. Output from before this point is
different in various ways and no longer supported. In general any
unversioned files one may encounter should be recompiled; however,
any that came from a version of mir-json before 20240823 will not
be readable by downstream tools and must be rebuilt.