aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authortv <tv@krebsco.de>2026-11-09 17:33:24 +0000
committertv <tv@krebsco.de>2026-11-09 19:01:58 +0100
commit3bf93bc192bf362b58b2161ac05da0bb8323bf43 (patch)
treefba76b2fbc59c427c04301a1b1fa38b976fa3b22 /src
parentb83bd5bdd9548b0e7ca7b1c9068dd47cdb5246d9 (diff)
docs: what is postponed or rejected stays in its own two files
Docs and comments outside future-work.md and review-rejections.md say what the code does, and point nowhere else for what it doesn't: the architecture page's map, the transports' forwarders, keys with `/`, a strict swarm's registry, trust.md's "Not yet" (now saying what isn't protected, in a sentence), the topology bench, and the comments of the change benchmarks, capabilities' grantor, tokens, dissemination, refusals and topology.
Diffstat (limited to 'src')
-rw-r--r--src/access/mod.rs3
-rw-r--r--src/access/token.rs3
-rw-r--r--src/document/bench.rs4
-rw-r--r--src/swarm/dissemination.rs3
-rw-r--r--src/swarm/refusals.rs3
-rw-r--r--src/swarm/topology/mod.rs3
6 files changed, 7 insertions, 12 deletions
diff --git a/src/access/mod.rs b/src/access/mod.rs
index f3e5f80..e223756 100644
--- a/src/access/mod.rs
+++ b/src/access/mod.rs
@@ -68,8 +68,7 @@ pub(crate) struct Capability {
/// nothing here.
pub(crate) rights: BTreeSet<String>,
/// Who granted it: a user (`user:<name>`), or for those the genesis node records, the
- /// node (its node ID). Kept so that granting on, by delegation, can come later
- /// without a new format (`future-work.md`, Authentication across nodes).
+ /// node (its node ID), kept with the capability.
#[serde(default)]
pub(crate) by: String,
/// When it was granted (Unix ms).
diff --git a/src/access/token.rs b/src/access/token.rs
index 153737e..51c2449 100644
--- a/src/access/token.rs
+++ b/src/access/token.rs
@@ -11,8 +11,7 @@
//!
//! Not Biscuit or UCAN (November 2026): a token only names a user, narrowing is asked
//! of a node (which issues a narrower one), and Biscuit would bring about a hundred
-//! crates, older versions of several of ours among them (Ed25519, SHA-2, protobuf):
-//! `future-work.md`, Authentication across nodes.
+//! crates, older versions of several of ours among them (Ed25519, SHA-2, protobuf).
use base64::{Engine, engine::general_purpose::URL_SAFE_NO_PAD as BASE64URL};
use serde::{Deserialize, Serialize};
diff --git a/src/document/bench.rs b/src/document/bench.rs
index 39a8dc7..db76ccc 100644
--- a/src/document/bench.rs
+++ b/src/document/bench.rs
@@ -8,7 +8,7 @@
//! ways on the same input.
//!
//! `change_signatures`: what signing every change by its committer's node key would
-//! cost (`future-work.md`, Write protection by checking changes): an Ed25519 signature
+//! cost: an Ed25519 signature
//! over a change's hash, made on every commit, checked on every change received.
//! Against what the node does anyway on the same input: a local write, a sync message
//! of many changes received (catching up), and a document of many changes loaded
@@ -20,7 +20,7 @@
//! same input (`changes::misplaced_author`).
//!
//! `change_paths`: what knowing every received change's paths would cost, to judge it by
-//! rules by path (`future-work.md`, Write protection by checking changes): each
+//! rules by path: each
//! change's operations decoded, and each object they name followed up to the root as
//! the change left it (`store::changed_by`, so every node finds the same paths). Against
//! receiving a sync message of many changes and loading a document of many changes, as
diff --git a/src/swarm/dissemination.rs b/src/swarm/dissemination.rs
index 9763449..4c15d0f 100644
--- a/src/swarm/dissemination.rs
+++ b/src/swarm/dissemination.rs
@@ -1,8 +1,7 @@
//! How a change reaches every member: whom a node sends a writer's changes to at once,
//! and whom it leaves to the announcement rounds (`swarm::relay`, which repair what it
//! misses: announcements, pulls, the slow round). Writers' trees (`swarm::tree`) are
-//! one way; others can be tried against them in the benchmark (`docs/future-work.md`,
-//! Swappable topology and dissemination). One per swarm: a node's part in passing a
+//! one way; others can be tried against them in the benchmark. One per swarm: a node's part in passing a
//! change on is worked out by itself and by its neighbours, and must agree.
//!
//! What every way keeps: the base underneath, pairs of neighbours syncing with
diff --git a/src/swarm/refusals.rs b/src/swarm/refusals.rs
index 30c3971..652f9bc 100644
--- a/src/swarm/refusals.rs
+++ b/src/swarm/refusals.rs
@@ -12,8 +12,7 @@
//! everything built on it: its document as it would be without them, its own writes
//! among them quarantined, the others' listed as refused (`AppState::drop_taken`); one
//! taking much, once a second member says so too. If its rules take it, the two
-//! policies disagree, which it logs; finding out which is right is left
-//! (`future-work.md`, Write protection by checking changes).
+//! policies disagree, which it logs; it doesn't find out which is right.
use std::time::Duration;
diff --git a/src/swarm/topology/mod.rs b/src/swarm/topology/mod.rs
index 2d812e5..8fae0ed 100644
--- a/src/swarm/topology/mod.rs
+++ b/src/swarm/topology/mod.rs
@@ -41,8 +41,7 @@ use graph::*;
pub(crate) use graph::{RingAndPairs, pair_key, pair_score};
/// How members' neighbours are chosen: the graph above (`RingAndPairs`) is one way;
-/// others can be tried against it in the benchmark (`docs/future-work.md`, Swappable
-/// topology and dissemination). One per swarm: a node's neighbours must count it as
+/// others can be tried against it in the benchmark. One per swarm: a node's neighbours must count it as
/// theirs.
///
/// A topology either computes a graph every node shares (`graph`: the same inputs give