aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/development.md18
1 files changed, 17 insertions, 1 deletions
diff --git a/docs/development.md b/docs/development.md
index 39eabdf..f921d22 100644
--- a/docs/development.md
+++ b/docs/development.md
@@ -123,7 +123,8 @@ and compares what the two say they are (`continuum --version`):
* **wire versions**: where they share one, the release rolls out node by node; where
they don't, every node upgrades together, which from 1.0.0 on only a major release
- may ask;
+ may ask. `scripts/wire-check` checks it, by a swarm of the last release's nodes and
+ this tree's (below);
* **Automerge**: where it differs, nobody remakes until every node runs the release;
* **the federation's revisions**: a release knowing a later one than the last is
tagged `federation-<F>.<R>` too, so that later releases are checked against it.
@@ -131,3 +132,18 @@ and compares what the two say they are (`continuum --version`):
What it finds heads the release's notes in the change log and its tag's message, with
what the build speaks and knows, and the notes. Before 1.0.0 every upgrade may still be
taken as a flag day, but the notes say when it isn't.
+
+`scripts/wire-check [TAG]` (the last release unless given) runs four nodes on this host,
+over libp2p on loopback: two of the tag's build and two of this tree's, in turns. Where
+their wire versions meet, each writes, and it checks that every node reads what each
+wrote and that none logs a peer of another wire version; where they don't, that the
+tag's nodes log this tree's as such, so their operators know to upgrade.
+
+```sh
+scripts/wire-check v0.0.1
+```
+
+A change to the wire format is a new version (`wire::VERSION`) beside the ones the build
+speaks already: the messages of the version before keep their types, frozen, and are
+encoded and decoded in `transport/wire.rs` beside the newest's, and `golden_bytes` keeps
+the bytes of each. A later release raises `wire::OLDEST` to leave the oldest out.