From 88e7410aaed5585ff3015cb7a6873ba17b88e9d7 Mon Sep 17 00:00:00 2001 From: Kensei Nakada Date: Fri, 10 May 2024 18:32:56 +0900 Subject: [PATCH] tortoisectl: format the CLI comments (#402) --- cmd/tortoisectl/commands/stop.go | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/cmd/tortoisectl/commands/stop.go b/cmd/tortoisectl/commands/stop.go index f730c621..d9b72253 100644 --- a/cmd/tortoisectl/commands/stop.go +++ b/cmd/tortoisectl/commands/stop.go @@ -24,8 +24,7 @@ import ( var stopCmd = &cobra.Command{ Use: "stop tortoise1 tortoise2...", Short: "stop tortoise(s) safely", - Long: ` -stop is the command to temporarily turn off tortoise(s) easily and safely. + Long: `stop is the command to temporarily turn off tortoise(s) easily and safely. It's intended to be used when your application is facing issues that might be caused by tortoise. Specifically, it changes the tortoise updateMode to "Off" and restarts the deployment to bring the pods back to the original resource requests. @@ -116,6 +115,6 @@ func init() { stopCmd.Flags().StringVarP(&stopNamespace, "namespace", "n", "", "namespace to stop tortoise(s) in") stopCmd.Flags().BoolVarP(&stopAll, "all", "A", false, "stop all tortoises in the specified namespace, or in all namespaces if no namespace is specified.") stopCmd.Flags().BoolVar(&noLoweringResources, "no-lowering-resources", false, `Stop tortoise without lowering resource requests. - If this flag is specified and the current Deployment's resource request(s) is lower than the current Pods' request mutated by Tortoise, - this CLI patches the deployment so that changing tortoise to Off won't result in lowering the resource request(s), damaging the service.`) + If this flag is specified and the current Deployment's resource request(s) is lower than the current Pods' request mutated by Tortoise, +this CLI patches the deployment so that changing tortoise to Off won't result in lowering the resource request(s), damaging the service.`) }