vinzenz/hyperhive
vinzenz/hyperhive
Watch
0
0
Fork
You've already forked hyperhive
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2

hive-forge, hivectl, swarmctl: fix clap help passive voice, regen docs

Browse source 
Rewrites every write-good.Passive hit in the hive-forge clap help text
into terse, imperative, active voice (meaning unchanged) and drops
clap-markdown's own fixed footer ('This document was generated
automatically by...') via MarkdownOptions::show_footer(false), since
that string isn't ours to reword and vale flagged it too.

docs/tools/{hivectl,swarmctl,forge}-cli.md are generated from each
crate's clap tree (see hive-forge/src/main.rs's MarkdownDocs verb) —
regenerated here from the fixed source, not hand-edited.

Refs #4549
This commit is contained in:
atlas 2026-09-20 05:38:30 +02:00 • committed by mara
commit f0e3ed04d3
18 changed files with 87 additions and 89 deletions
Download patch file Download diff file Expand all files Collapse all files

12
swarmctl/src/main.rs
View file

@ -159,7 +159,7 @@ enum AgentVerb {
/// SSO identity, forge user, config repo, and the deploy message that
/// puts the agent on `--hive` — and prints the queued job's node id.
///
/// **This returns as soon as the work is queued.** It doesn't wait,
/// **This returns as soon as it queues the work.** It doesn't wait,
/// and a finished graph would not mean the agent is up either: the
/// last node publishes a deploy, after which the hive converges on its
/// own clock. Watch the swarm UI's job view, or the hive itself, for
@ -175,12 +175,12 @@ struct AgentCreateArgs {
/// Name for the new agent: 1–63 characters of `[a-z0-9-]`.
///
/// Becomes an SSO subject, a forge user and a repository name, so
/// it's validated here before anything is queued.
/// it's validated here before queuing.
name: String,
/// Hive in this swarm to deploy the agent to.
///
/// Required, and deliberately not defaulted: it's an *address* — the
/// hive a deploy message is sent to — and only the operator knows
/// hive that gets the deploy message — and only the operator knows
/// which one they mean. The controller checks it against the swarm's
/// hive roster and names the known hives if it misses.
#[arg(long, value_name = "HIVE")]
@ -275,7 +275,11 @@ fn main() -> Result<()> {
command: UserVerb::List,
} => user_list(&paths.resolve()?),
Verb::MarkdownDocs => {
print!("{}", clap_markdown::help_markdown::<Cli>());
// `show_footer(false)`: drop clap-markdown's own fixed
// "This document was generated automatically by..." footer —
// it's the one string in this doc that isn't ours to reword.
let options = clap_markdown::MarkdownOptions::new().show_footer(false);
print!("{}", clap_markdown::help_markdown_custom::<Cli>(&options));
Ok(())
}
Verb::Completions { shell } => {