Skip to content

Commit 00247b5

Browse files
committed
doc: man: Add some details to subcommands
The subcommands descriptions for create, release-from and flashscript had some extra details in the old rst manpages, not available in the argparse/cli help. Migrate these descriptions into argparse. Signed-off-by: Jonas Rebmann <jre@pengutronix.de>
1 parent 4951927 commit 00247b5

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

labgrid/remote/client.py

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1803,7 +1803,8 @@ def man_add_parser(self, name, **kwargs):
18031803
subparser = subparsers.add_parser("show", help="show a place and related resources")
18041804
subparser.set_defaults(func=ClientSession.print_place)
18051805

1806-
subparser = subparsers.add_parser("create", help="add a new place")
1806+
subparser = subparsers.add_parser("create", help="add a new place with the name specified via "
1807+
"``--place`` or the ``LG_PLACE`` environment variable")
18071808
subparser.set_defaults(func=ClientSession.add_place)
18081809

18091810
subparser = subparsers.add_parser("delete", help="delete an existing place")
@@ -1851,8 +1852,10 @@ def man_add_parser(self, name, **kwargs):
18511852
subparser.set_defaults(func=ClientSession.release)
18521853

18531854
subparser = subparsers.add_parser(
1854-
"release-from", help="atomically release a place, but only if locked by a specific user"
1855-
)
1855+
"release-from", help="atomically release a place, but only if locked by a specific user",
1856+
epilog="Note that this command returns success as long as the specified user no longer owns the place, "
1857+
"meaning it may be acquired by another user or not at all.",
1858+
)
18561859
subparser.add_argument("acquired", metavar="HOST/USER", help="User and host to match against when releasing")
18571860
subparser.set_defaults(func=ClientSession.release_from)
18581861

@@ -1901,7 +1904,7 @@ def man_add_parser(self, name, **kwargs):
19011904
subparser.add_argument("--name", "-n", help="optional resource name")
19021905
subparser.set_defaults(func=ClientSession.fastboot)
19031906

1904-
subparser = subparsers.add_parser("flashscript", help="run flash script")
1907+
subparser = subparsers.add_parser("flashscript", help="Run arbitrary script with arguments to flash device")
19051908
subparser.add_argument("script", help="Flashing script")
19061909
subparser.add_argument("script_args", metavar="ARG", nargs=argparse.REMAINDER, help="script arguments")
19071910
subparser.add_argument("--name", "-n", help="optional resource name")

man/labgrid-client.1

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ Log output to FILE
257257
.UNINDENT
258258
.SS labgrid\-client create
259259
.sp
260-
add a new place
260+
add a new place with the name specified via \fB\-\-place\fP or the \fBLG_PLACE\fP environment variable
261261
.INDENT 0.0
262262
.INDENT 3.5
263263
.sp
@@ -401,7 +401,7 @@ optional resource name
401401
.UNINDENT
402402
.SS labgrid\-client flashscript
403403
.sp
404-
run flash script
404+
Run arbitrary script with arguments to flash device
405405
.INDENT 0.0
406406
.INDENT 3.5
407407
.sp
@@ -548,6 +548,8 @@ usage: labgrid\-client release\-from HOST/USER
548548
.B host/user
549549
User and host to match against when releasing
550550
.UNINDENT
551+
.sp
552+
Note that this command returns success as long as the specified user no longer owns the place, meaning it may be acquired by another user or not at all.
551553
.SS labgrid\-client release|unlock
552554
.sp
553555
release a place

0 commit comments

Comments
 (0)