aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/development.md23
-rw-r--r--docs/store.md2
2 files changed, 15 insertions, 10 deletions
diff --git a/docs/development.md b/docs/development.md
index 85f6fce..314ae11 100644
--- a/docs/development.md
+++ b/docs/development.md
@@ -3,19 +3,22 @@
## The loop
```sh
-cargo check --features mycelium,libp2p,tor,dashboard # does it compile: seconds
-cargo quick # every test but the simulations: seconds
-cargo sim # the simulations (src/simtest/): under a minute
-cargo test --features mycelium,libp2p,tor,dashboard # both
-cargo benchmarks # the benchmarks, in release builds
+cargo check --features mycelium,libp2p,tor,dashboard,federation # does it compile: seconds
+cargo quick # every test but the simulations: seconds
+cargo sim # the simulations (src/simtest/): under a minute
+cargo test --features mycelium,libp2p,tor,dashboard,federation # both
+cargo benchmarks # the benchmarks, in release builds
```
`cargo quick`, `cargo sim` and `cargo benchmarks` are aliases ([`.cargo/config.toml`](../.cargo/config.toml)),
-with every transport and the dashboard (`dashboard`, `GET /admin/dashboard`;
-[`docs/dashboard.md`](dashboard.md)). Each transport is a feature, none of them default, and a build
-needs at least one: a transport left out takes its tests and dependencies with it
-(`--features libp2p` builds neither `reqwest` and the daemon supervision of Mycelium,
-nor arti; among Mycelium's tests is a swarm simulated on its envelope).
+with every transport, the dashboard (`dashboard`, `GET /admin/dashboard`;
+[`docs/dashboard.md`](dashboard.md)) and the federation (`federation`, built stage by stage and
+not yet run by a node: [`docs/federation.md`](federation.md), [`docs/store.md`](store.md)); a
+build without `federation` runs the tests continuum has without it. Each transport is a feature,
+none of them default, and a build needs at least one: a transport left out takes its tests
+and dependencies with it (`--features libp2p` builds neither `reqwest` and the daemon
+supervision of Mycelium, nor arti; among Mycelium's tests is a swarm simulated on its
+envelope).
The benchmarks are ignored tests named `bench_*`: the document's (writes and sync
messages, what signing and checking every change would cost: `bench_change_signatures`,
diff --git a/docs/store.md b/docs/store.md
index 002b906..b766d41 100644
--- a/docs/store.md
+++ b/docs/store.md
@@ -113,6 +113,8 @@ pub trait Fold {
}
/// The checkpoint at `heads`, read as `at`: its bytes, and the events it keeps.
fn checkpoint(at: &Self::State, heads: &[Id]) -> (Vec<u8>, Vec<Id>);
+ /// The heads a checkpoint was built at, and the events it keeps.
+ fn parts(checkpoint: &[u8]) -> Option<(Vec<Id>, Vec<Id>)>;
/// The state a checkpoint reads as, with the events it keeps.
fn start(checkpoint: &[u8], kept: &[(Id, Vec<u8>)]) -> Result<Self::State, Refused>;
/// The root of a fork at `heads` of the stores reading as `at`, made by `spec`.