From 9cfb6083927ca95b469d312bebf1269d8358d252 Mon Sep 17 00:00:00 2001 From: VEERENDRA VAMSHI <136776337+MKVEERENDRA@users.noreply.github.com> Date: Fri, 7 Mar 2025 14:22:51 +0530 Subject: [PATCH] Update wtclient CLI commands with refined descriptions and formatting fixes. - Added detailed descriptions for the session and terminate commands in wtclient to improve user guidance and clarity. - Changed the ArgsUsage for the session command from 'id' to 'session_id'. - Refined descriptions to explain the purpose of each command. - Fixed long description lines to adhere to the 80-character line limit. - Updated the release notes for version 0.19.0. Fixes: #9583 --- cmd/commands/wtclient.go | 14 +++++++++++--- docs/release-notes/release-notes-0.19.0.md | 5 +++++ 2 files changed, 16 insertions(+), 3 deletions(-) diff --git a/cmd/commands/wtclient.go b/cmd/commands/wtclient.go index 075861b981c..4e9822d70e0 100644 --- a/cmd/commands/wtclient.go +++ b/cmd/commands/wtclient.go @@ -376,15 +376,23 @@ func policy(ctx *cli.Context) error { } var sessionCommands = cli.Command{ - Name: "session", + Name: "session", + Usage: "Manage watchtower client sessions.", + Description: "This command allows users " + + "to manage their watchtower client sessions," + + "specifically to terminate an active session", Subcommands: []cli.Command{ terminateSessionCommand, }, } var terminateSessionCommand = cli.Command{ - Name: "terminate", - ArgsUsage: "id", + Name: "terminate", + Usage: "Terminate an active watchtower session.", + Description: "This command ends a session using " + + "its unique session ID. It stops further backups " + + "but does not affect past backup data", + ArgsUsage: "session_id", Action: actionDecorator(terminateSession), } diff --git a/docs/release-notes/release-notes-0.19.0.md b/docs/release-notes/release-notes-0.19.0.md index d974d89b5a7..4b17170e191 100644 --- a/docs/release-notes/release-notes-0.19.0.md +++ b/docs/release-notes/release-notes-0.19.0.md @@ -270,6 +270,11 @@ The underlying functionality between those two options remain the same. [1](https://github.com/lightningnetwork/lnd/pull/9476) [2](https://github.com/lightningnetwork/lnd/pull/9477) [3](https://github.com/lightningnetwork/lnd/pull/9478). + +* [Watchtower Client Commands](https://github.com/lightningnetwork/lnd/pull/9588): - +Added detailed descriptions for the session and terminate commands in lncli wtclient. +The session command now explains its purpose and how it manages watchtower sessions. +The terminate command provides clear guidance on terminating an active session by specifying its unique session ID. ## Breaking Changes ## Performance Improvements