rewrite generated CLI docs' passive voice to active

hive-forge and hivectl doc-comment strings for pr-create --label, diff
--full, list --label, ci-runs --branch, and several hivectl subcommand
options read as if things happened to themselves. Name the actor (hivectl,
hive-forge, or the CLI) instead, and regenerate the three docs/tools/*-cli.md
files from the rebuilt binaries.

swarmctl-cli.md needs no source change: its only passive hit is
clap-markdown's own generated boilerplate, out of scope here.
This commit is contained in:
iris 2026-09-08 14:46:52 +02:00 committed by mara
commit 7396903994
7 changed files with 39 additions and 39 deletions

View file

@ -130,13 +130,13 @@ pub enum Cmd {
scope: ScopeArgs,
/// Gracefully quiesce each agent before stopping, instead of a
/// hard stop. Each agent gets a graceful-stop DAG on the job
/// queue: the harness is signalled, runs one stop-checkpoint
/// turn to flush durable `/state`, drains, then the container
/// is stopped (bounded by a 3-min timeout that falls back to a
/// queue: it signals the harness, which runs one stop-checkpoint
/// turn to flush durable `/state` and drains, then the DAG stops
/// the container (bounded by a 3-min timeout that falls back to a
/// hard stop). All drains overlap. Applies to agents only.
#[arg(long)]
graceful: bool,
/// Return immediately after the stop DAGs are queued instead of
/// Return immediately after hivectl queues the stop DAGs instead of
/// waiting for them with live per-node progress.
#[arg(long)]
no_wait: bool,
@ -149,7 +149,7 @@ pub enum Cmd {
Start {
#[command(flatten)]
scope: ScopeArgs,
/// Return immediately after the start DAGs are queued instead
/// Return immediately after hivectl queues the start DAGs instead
/// of waiting for them with live per-node progress.
#[arg(long)]
no_wait: bool,
@ -252,7 +252,7 @@ pub enum ForgeCmd {
///
/// For an existing agent, persists the token to its state dir; for a
/// human/other account, prints the token to stdout. Set a password to
/// enable forge web-UI login (a random throwaway is used otherwise).
/// enable forge web-UI login (otherwise it uses a random throwaway).
CreateUser {
/// Forgejo username. For agents: the container/agent name
/// (`<n>` in `h-<n>`; manager uses the literal `manager`).
@ -281,7 +281,7 @@ pub enum ForgeCmd {
ReconcileConfig {
/// Agent whose config branches to reconcile.
agent: String,
/// Which side to reconcile from. Omit to be prompted after the diff.
/// Which side to reconcile from. Omit it and hivectl prompts you after the diff.
#[arg(long, value_enum)]
from: Option<ReconcileFrom>,
/// Include the full diff (not just `--stat`) in the report.
@ -315,8 +315,8 @@ pub enum MatrixCmd {
///
/// For an existing agent, persists the token to its state dir; for a
/// human/other account, prints the access token to stdout. Set a
/// password to enable matrix web-client login (a random throwaway is
/// used otherwise).
/// password to enable matrix web-client login (otherwise it uses a
/// random throwaway).
CreateUser {
/// Matrix localpart. For agents: the container/agent name.
/// For humans: any matrix localpart — `mara`, `damocles`, etc.
@ -454,7 +454,7 @@ pub(crate) use hive_host_sock::HOST_SOCKET as DEFAULT_HOST_SOCKET;
pub enum AgentCmd {
/// Stop and start this agent container without rebuilding config.
Restart {
/// Return immediately after the restart DAG is queued.
/// Return immediately after hivectl queues the restart DAG.
#[arg(long)]
no_wait: bool,
},
@ -466,7 +466,7 @@ pub enum AgentCmd {
/// backlog drains on `resume`. Sticky: it survives a restart, and
/// pausing a stopped agent makes it come up paused.
Pause {
/// Return immediately after the pause DAG is queued instead of
/// Return immediately after hivectl queues the pause DAG instead of
/// waiting for the harness to acknowledge it.
#[arg(long)]
no_wait: bool,
@ -477,8 +477,8 @@ pub enum AgentCmd {
/// has no config/topology entry at all — it never attempts
/// first-time creation. Use `create` for that.
Start {
/// Start (or leave) the agent paused: if it's currently down, the
/// pause marker is written before the container boots, so it comes
/// Start (or leave) the agent paused: if it's currently down, hivectl
/// writes the pause marker before the container boots, so it comes
/// up paused instead of driving turns immediately. If it's already
/// running, this pauses it in place and doesn't attempt a
/// (re)start.