From 2dad97a75cdb264866cd6323559edf690c0dd9dc Mon Sep 17 00:00:00 2001 From: github-merge-queue <118344674+github-merge-queue@users.noreply.github.com> Date: Fri, 7 Feb 2025 07:03:16 +0000 Subject: [PATCH 1/2] Update Forest CLI docs --- docs/docs/users/reference/cli.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/docs/users/reference/cli.md b/docs/docs/users/reference/cli.md index 8a16369c3c00..e6b02240d4a0 100644 --- a/docs/docs/users/reference/cli.md +++ b/docs/docs/users/reference/cli.md @@ -767,8 +767,10 @@ Print healthcheck info Usage: forest-cli healthcheck Commands: - ready Display ready status - help Print this message or the help of the given subcommand(s) + ready Display ready status + live Display live status + healthy Display live status + help Print this message or the help of the given subcommand(s) Options: -h, --help Print help From 9c7abc864cf167f3f336c95194314c96e9a6a91a Mon Sep 17 00:00:00 2001 From: hanabi1224 Date: Fri, 7 Feb 2025 16:02:11 +0800 Subject: [PATCH 2/2] fix wording --- docs/docs/users/reference/cli.md | 6 +++--- src/cli/subcommands/healthcheck_cmd.rs | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/docs/users/reference/cli.md b/docs/docs/users/reference/cli.md index e6b02240d4a0..cab59acd42bc 100644 --- a/docs/docs/users/reference/cli.md +++ b/docs/docs/users/reference/cli.md @@ -767,9 +767,9 @@ Print healthcheck info Usage: forest-cli healthcheck Commands: - ready Display ready status - live Display live status - healthy Display live status + ready Display readiness status + live Display liveness status + healthy Display health status help Print this message or the help of the given subcommand(s) Options: diff --git a/src/cli/subcommands/healthcheck_cmd.rs b/src/cli/subcommands/healthcheck_cmd.rs index 0404cf102d3c..4bfaffb02f5a 100644 --- a/src/cli/subcommands/healthcheck_cmd.rs +++ b/src/cli/subcommands/healthcheck_cmd.rs @@ -14,7 +14,7 @@ use ticker::Ticker; #[derive(Debug, Subcommand)] pub enum HealthcheckCommand { - /// Display ready status + /// Display readiness status Ready { /// Don't exit until node is ready #[arg(long)] @@ -23,7 +23,7 @@ pub enum HealthcheckCommand { #[arg(long, default_value_t=DEFAULT_HEALTHCHECK_PORT)] healthcheck_port: u16, }, - /// Display live status + /// Display liveness status Live { /// Don't exit until node is ready #[arg(long)] @@ -32,7 +32,7 @@ pub enum HealthcheckCommand { #[arg(long, default_value_t=DEFAULT_HEALTHCHECK_PORT)] healthcheck_port: u16, }, - /// Display live status + /// Display health status Healthy { /// Don't exit until node is ready #[arg(long)]