diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/dashboard.md | 3 | ||||
| -rw-r--r-- | docs/guides/federation/proposing-and-voting.md | 32 | ||||
| -rw-r--r-- | docs/guides/federation/upgrades.md | 12 |
3 files changed, 29 insertions, 18 deletions
diff --git a/docs/dashboard.md b/docs/dashboard.md index f68fb06..4ecd233 100644 --- a/docs/dashboard.md +++ b/docs/dashboard.md @@ -413,7 +413,8 @@ federation again; the page keeps the choice. While shown, it is read every 5 s: whether it passed, is dead, or can still pass; the parties voting `true` and `false`; how many events propose it and how many votes are on it; why no party's client backs it, where none does (no version as this node reads it, say); and what its version - changes of the current one, a line each, as `continuum-party proposals` says it; + changes of the current one, a line each, as `continuum-party check` says it of a fork's + version; * **refused**: what this node refused by what it took before (keys voted twice: tell its party), what it dropped as its operator says, and what it refused as every node does, each with its kind and why. diff --git a/docs/guides/federation/proposing-and-voting.md b/docs/guides/federation/proposing-and-voting.md index 739552b..d8410f6 100644 --- a/docs/guides/federation/proposing-and-voting.md +++ b/docs/guides/federation/proposing-and-voting.md @@ -196,21 +196,31 @@ curl -s -u tv:secret localhost:3000/events/counts | jq .proposals # "proposals":["c41e…"],"votes":["5a77…","e019…"],"yes":["tv"]}} ``` -The client shows the same, why it backs one not, by the federation it knows, what each -proposal's version changes of the current one, field by field and party by party, and -the places holding a value whose writer it changes (`who writes names/wiki/a: tv -> -wiki`): admitting a party named as a segment of a place is, or changing the rules or -their order, moves who writes there, rules unchanged in the first case, and what was -written there counts no more once it passes: +The client shows a proposal in words before anyone votes on it (`show`, and `proposals` +for all of them): whether it passed or is dead, who voted what and how many more `true` +pass it, who proposed it, and what its version does, not its JSON. That is the parties +it lets in or takes out, with their keys by fingerprint (as `ssh-keygen -l` gives them) +and their nodes; the keys and node lists it names anew; the rules it adds or drops, where +they are among the rules; the checkpoint it moves the store to, and what moving there +refuses of what the node took; the revision it moves to, and the nodes not known to know +it. And the places holding a value whose writer it changes (`who writes`): admitting a +party named as a segment of a place is, or changing the rules or their order, moves who +writes there, rules unchanged in the first case, and what was written there counts no +more once it passes. Where no client backs it, it says why, by the federation it knows: ```sh -continuum-party --node http://tv:secret@localhost:3000 proposals -# 8d02…: dead; true: tv; false: lass -# changes: null -> "1f4c…" -# checkpoint: - -> ["4a1d…","9e30…"] -# number: 0 -> 1 +continuum-party --node http://tv:secret@localhost:3000 show 8d02 +# 8d02…: can still pass, 1 more `true` passing it (3 of 4); true: tv, lass; false: nobody +# proposed by tv: version 2 on 1 +# lets makefu in: 1 key (ssh-ed25519 SHA256:IDPEVCc1gUXL…); 1 node (continuum:e2a8f0c1d9b3…) +# adds rule 1: names/r/wiki -> lass +# who writes names/r/wiki: tv -> lass ``` +`vote` says the same before it casts anything, then its warnings, and, on a terminal, +asks before it casts: answer `y` to cast, anything else to cast nothing. In a script, +with no terminal, it asks nothing. + A node's dashboard shows them so too, and where the node votes for its party by itself, votes through it ([`dashboard.md`](../../dashboard.md), [Federation](../../dashboard.md#federation)). diff --git a/docs/guides/federation/upgrades.md b/docs/guides/federation/upgrades.md index f6964a6..6ffde67 100644 --- a/docs/guides/federation/upgrades.md +++ b/docs/guides/federation/upgrades.md @@ -101,13 +101,13 @@ adds is refused everywhere until a version names it. 3. **Vote.** Each party backs it once every node of the party knows the revision: ```sh - continuum-party --node http://tv:secret@localhost:3000 proposals - # 5e81…: can still pass; true: tv; false: nobody - # changes: "1f4c…" -> "8a20…" - # number: 4 -> 5 - # revision: the base revision -> revision 1 (merge-events), 6c1d… + continuum-party --node http://tv:secret@localhost:3000 show 5e81 + # 5e81…: can still pass, 2 more `true` passing it (3 of 4); true: tv; false: nobody + # proposed by tv: version 5 on 4 + # moves to revision 1 (merge-events) + # not known to know revision 1 (merge-events): lass: continuum:9c07… said nothing: … continuum-party --node http://tv:secret@localhost:3000 --key tv.key \ - --record tv.record vote 5e81… yes + --record tv.record vote 5e81 yes ``` The client backs it only where its node knows the revision, and says so otherwise. It |
