Skip to content

Add version to linking metadata section #57

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Apr 26, 2018
Merged

Add version to linking metadata section #57

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 14 additions & 2 deletions Linking.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,20 @@ Linking Metadata Section
A linking metadata section is a user-defined section with the name
"linking".

A linking metadata section contains a series of sub-sections layed
out in the same way as the ["names"][names_sec] section:
A linking metadata section begins with a version number which is then followed
by a series of sub-sections laid out in the same way as the ["names"][names_sec]
section:

| Field | Type | Description |
| ----------- | ------------- | ------------------------------------ |
| version | `varuint32` | the version of linking metadata contained in this
section |
| subsections | `subsection*` | sequence of `subsection` |

This `version` allows for breaking changes to be made to the format described
here. Tools can then choose to reject imputs contained unexpected versions.

Each `subsection` is encoded as:

| Field | Type | Description |
| ------------ | ----------- | ------------------------------------ |
Expand Down