docs: disambiguate protocol version #3034
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Tagging @rootulp for a quick check here. |
rootulp
approved these changes
May 8, 2024
cason
approved these changes
May 8, 2024
| | block_version | uint64 | The CometBFT Block Protocol version | 2 | | ||
| | p2p_version | uint64 | The CometBFT P2P Protocol version | 3 | | ||
| | block_version | uint64 | The CometBFT Block version | 2 | | ||
| | p2p_version | uint64 | The CometBFT P2P version | 3 | |
There was a problem hiding this comment.
Should we keep protocol here?
| @@ -42,7 +42,7 @@ title: Methods | |||
| |---------------------|--------|-----------------------------------------------------|--------------|---------------| | |||
| | data | string | Some arbitrary information | 1 | N/A | | |||
| | version | string | The application software semantic version | 2 | N/A | | |||
There was a problem hiding this comment.
What is the difference between version and app_version here?
| @@ -147,10 +147,10 @@ NOTE: that this is more specifically the consensus version and doesn't include i | |||
| P2P Version. (TODO: we should write a comprehensive document about | |||
| versioning that this can refer to) | |||
|
|
|||
| | Name | type | Description | Validation | | |||
There was a problem hiding this comment.
Can we reword the previous paragraph?
Maybe we should only mention that the p2p version is not part of this Version field. The p2p version is only relevant at the p2p communication layer.
mergify bot
pushed a commit
that referenced
this pull request
May 8, 2024
Closes #3030 --- #### PR checklist - [ ] ~~Tests written/updated~~ - [ ] ~~Changelog entry added in `.changelog` (we use [unclog](https://github.com/informalsystems/unclog) to manage our changelog)~~ - [x] Updated relevant documentation (`docs/` or `spec/`) and code comments - [x] Title follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec (cherry picked from commit daa043a)
4 tasks
melekes
added a commit
that referenced
this pull request
May 8, 2024
Closes #3030 --- #### PR checklist - [ ] ~~Tests written/updated~~ - [ ] ~~Changelog entry added in `.changelog` (we use [unclog](https://github.com/informalsystems/unclog) to manage our changelog)~~ - [x] Updated relevant documentation (`docs/` or `spec/`) and code comments - [x] Title follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec <hr>This is an automatic backport of pull request #3034 done by [Mergify](https://mergify.com). Co-authored-by: Anton Kaliaev <[email protected]>
|
@mergify backport v0.34.x |
|
@mergify backport v0.37.x |
✅ Backports have been created
|
✅ Backports have been created
|
|
@mergify backport v0.38.x |
✅ Backports have been created
|
mergify bot
pushed a commit
that referenced
this pull request
May 8, 2024
Closes #3030 --- #### PR checklist - [ ] ~~Tests written/updated~~ - [ ] ~~Changelog entry added in `.changelog` (we use [unclog](https://github.com/informalsystems/unclog) to manage our changelog)~~ - [x] Updated relevant documentation (`docs/` or `spec/`) and code comments - [x] Title follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec (cherry picked from commit daa043a) # Conflicts: # spec/abci/abci++_methods.md # spec/core/data_structures.md
mergify bot
pushed a commit
that referenced
this pull request
May 8, 2024
Closes #3030 --- #### PR checklist - [ ] ~~Tests written/updated~~ - [ ] ~~Changelog entry added in `.changelog` (we use [unclog](https://github.com/informalsystems/unclog) to manage our changelog)~~ - [x] Updated relevant documentation (`docs/` or `spec/`) and code comments - [x] Title follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec (cherry picked from commit daa043a) # Conflicts: # spec/abci/abci++_methods.md # spec/core/data_structures.md
4 tasks
mergify bot
pushed a commit
that referenced
this pull request
May 8, 2024
Closes #3030 --- #### PR checklist - [ ] ~~Tests written/updated~~ - [ ] ~~Changelog entry added in `.changelog` (we use [unclog](https://github.com/informalsystems/unclog) to manage our changelog)~~ - [x] Updated relevant documentation (`docs/` or `spec/`) and code comments - [x] Title follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec (cherry picked from commit daa043a) # Conflicts: # spec/core/data_structures.md
This was referenced May 8, 2024
melekes
added a commit
that referenced
this pull request
May 8, 2024
Closes #3030 --- #### PR checklist - [ ] ~~Tests written/updated~~ - [ ] ~~Changelog entry added in `.changelog` (we use [unclog](https://github.com/informalsystems/unclog) to manage our changelog)~~ - [x] Updated relevant documentation (`docs/` or `spec/`) and code comments - [x] Title follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec <hr>This is an automatic backport of pull request #3034 done by [Mergify](https://mergify.com). --------- Co-authored-by: Anton Kaliaev <[email protected]>
melekes
added a commit
that referenced
this pull request
May 8, 2024
Closes #3030 --- #### PR checklist - [ ] ~~Tests written/updated~~ - [ ] ~~Changelog entry added in `.changelog` (we use [unclog](https://github.com/informalsystems/unclog) to manage our changelog)~~ - [x] Updated relevant documentation (`docs/` or `spec/`) and code comments - [x] Title follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec <hr>This is an automatic backport of pull request #3034 done by [Mergify](https://mergify.com). --------- Co-authored-by: Anton Kaliaev <[email protected]>
melekes
added a commit
that referenced
this pull request
May 8, 2024
Closes #3030 --- #### PR checklist - [ ] ~~Tests written/updated~~ - [ ] ~~Changelog entry added in `.changelog` (we use [unclog](https://github.com/informalsystems/unclog) to manage our changelog)~~ - [x] Updated relevant documentation (`docs/` or `spec/`) and code comments - [x] Title follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec <hr>This is an automatic backport of pull request #3034 done by [Mergify](https://mergify.com). --------- Co-authored-by: Anton Kaliaev <[email protected]>
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #3030
PR checklist
Tests written/updatedChangelog entry added in.changelog(we use unclog to manage our changelog)docs/orspec/) and code comments