From 1a67ac18f36045fcdef1caf11204df93d60b4c1a Mon Sep 17 00:00:00 2001 From: Lorenz Leutgeb Date: Tue, 20 May 2025 19:03:58 +0200 Subject: [PATCH] cli: reword sync replicas help Reword the help message of `--replicas` and `--max-replicas`, while also improving the documentation on how the fetch and announce functionality works. --- radicle-cli/src/commands/sync.rs | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/radicle-cli/src/commands/sync.rs b/radicle-cli/src/commands/sync.rs index c3f1c9da..5d872566 100644 --- a/radicle-cli/src/commands/sync.rs +++ b/radicle-cli/src/commands/sync.rs @@ -49,11 +49,20 @@ Usage When `--replicas` is specified, the given replication factor will try to be matched. For example, `--replicas 5` will sync with 5 seeds. - When `--max-replicas` is specified without `--replicas`, it acts the same a - replicas. Otherwise, it will use the value as an upper bound of seed to - replicate from. If the max is not reached, the sync is still considered a - success. For example, `--replicas 2 --max-replicas 3` will sync with 2 seeds - and attempt to sync with a third. + The synchronization process can be configured using `--replicas ` and + `--replicas-max `. If these options are used independently, then the + replication factor is taken as the given ``/`` value. If the + options are used together, then the replication factor has a minimum and + maximum bound. + + For fetching, the synchronization process will be considered successful if + at least `` seeds were fetched from *or* all preferred seeds were + fetched from. If `` is specified then the process will continue and + attempt to sync with `` seeds. + + For reference announcing, the synchronization process will be considered + successful if at least `` seeds were pushed to *and* all preferred + seeds were pushed to. When `--fetch` or `--announce` are specified on their own, this command will only fetch or announce.