Skip to content

Commit 79740e7

Browse files
committed
DOC: edit help for 'save-and-restore' tool
1 parent 254c6bd commit 79740e7

File tree

1 file changed

+5
-3
lines changed
  • src/save_and_restore_api/tools

1 file changed

+5
-3
lines changed

src/save_and_restore_api/tools/cli.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,6 @@ def formatter(prog):
8787
parser = argparse.ArgumentParser(
8888
description="save-and-restore: CLI tool for operations on Save-and-Restore nodes.\n"
8989
f"save-and-restore-api version {version}\n\n"
90-
"The tool connects to the save-and-restore service to perform the selected operation. \n"
9190
"The following operations are currently supported:\n"
9291
" LOGIN: check user login credentials.\n"
9392
" CONFIG GET: read an existing config node.\n"
@@ -106,8 +105,11 @@ def formatter(prog):
106105
" SAVE_AND_RESTORE_API_USER_PASSWORD: user password (use with caution).\n"
107106
"CLI parameters override the respective environment variables.\n"
108107
"\n"
109-
"The program returns 0 if the operation is successful. Non-zero return codes\n"
110-
"indicate errors.\n"
108+
"\n"
109+
"Exit codes:\n"
110+
" 0: operation successful;\n"
111+
" 1: error in command line parameters;\n"
112+
" 2: operation failed.\n"
111113
"\n"
112114
"Examples:\n"
113115
"\n"

0 commit comments

Comments
 (0)