aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/federation.md6
-rw-r--r--docs/guides/federation/forking-and-following.md15
-rw-r--r--docs/openapi.yaml11
3 files changed, 24 insertions, 8 deletions
diff --git a/docs/federation.md b/docs/federation.md
index f36eabd..e47da93 100644
--- a/docs/federation.md
+++ b/docs/federation.md
@@ -619,12 +619,14 @@ store of its own from the federation's ([`store.md`](store.md), [Forks](store.md
heads with that version current. Every proposal is a chance to fork: the version is
usually one that didn't pass.
2. A fork is named by its root's ID, which nobody can steer to a given name, the
- federation it came from least of all. It takes only events with its root in their
+ federation it came from least of all; a few of its first digits can be, by trying
+ versions, so an ID is compared whole. It takes only events with its root in their
history: what the stayers sign after it isn't taken there, nor what the fork's
parties sign after it in the federation they left.
3. The others join it as a node joins any swarm, by its ID. A node holding the history
up to those heads builds the root and checks it, says what it holds that those heads
- lack, and, party by party, whether the fork's version gives it the keys it had there:
+ lack, what the fork's version changes of the one current there, its rules and their
+ order among it, and, party by party, whether it gives the party the keys it had there:
a founder may give a party that didn't go keys of its own. A node that doesn't hold
that history takes the root on its operator's word, as its operator names the fork.
diff --git a/docs/guides/federation/forking-and-following.md b/docs/guides/federation/forking-and-following.md
index ffc4fae..dafa974 100644
--- a/docs/guides/federation/forking-and-following.md
+++ b/docs/guides/federation/forking-and-following.md
@@ -55,14 +55,21 @@ A node holding the history up to the fork's heads builds its root and checks it:
continuum-party --node http://lass:secret@localhost:3000 check fork-root
# 7c55…: built here, byte for byte
# its heads lack 0c7e…
+# its version changes:
+# changes: "3a90…" -> "b41f…"
+# keys.makefu: {"keys":["ssh-ed25519 AAAA…"],"since":2} -> {"keys":[…],"since":5}
+# nodes.lass: {"nodes":["continuum:9c07…"],"since":0} -> {…,"since":5}
+# number: 4 -> 5
# makefu's keys: ["ssh-ed25519 AAAA…"] here, ["ssh-ed25519 AAAA…"] in the fork
```
Whether it builds that root at those heads; what it took that the heads lack (neither
-among them, in their history, nor above them), which the fork doesn't hold; and, party by
-party, the keys the fork's version gives otherwise than the party had at those heads. A
-node that doesn't hold that history takes the root on its operator's word, who names the
-fork by its ID.
+among them, in their history, nor above them), which the fork doesn't hold; what the
+fork's version changes of the one current at those heads, field by field, its rules and
+their order among them, which say who writes where; and, party by party, the keys the
+fork's version gives otherwise than the party had at those heads. A node that doesn't
+hold that history takes the root on its operator's word, who names the fork by its ID:
+compare that ID whole, as a founder trying versions can steer its first few digits.
## Following
diff --git a/docs/openapi.yaml b/docs/openapi.yaml
index 4982cac..6cef2f2 100644
--- a/docs/openapi.yaml
+++ b/docs/openapi.yaml
@@ -1694,7 +1694,10 @@ paths:
byte for byte, and why it builds none where it doesn't (heads it doesn't hold,
a version that is no fork); what it holds that those heads lack (`lacking`:
events it took that are neither among them, nor in their history, nor above
- them); and the parties whose keys the fork's version gives otherwise than they
+ them); what the fork's version changes of the version current at those heads, a
+ line each as `field: before -> after`, its rules among them, `keys` and `nodes`
+ party by party (`changes`); and the parties whose keys the fork's version gives
+ otherwise than they
had at those heads, each with its keys there and in the fork. A node that
doesn't hold that history takes a fork's root on its operator's word, who names
the fork by its ID (`--store-id`).
@@ -1712,7 +1715,7 @@ paths:
application/json:
schema:
type: object
- required: [fork, builds, why, lacking, keys]
+ required: [fork, builds, why, lacking, changes, keys]
properties:
fork:
type: string
@@ -1725,6 +1728,10 @@ paths:
type: array
items:
type: string
+ changes:
+ type: array
+ items:
+ type: string
keys:
type: object
additionalProperties: