Skip to content

Commit

Permalink
man: document new commands and env variables for place reservation
Browse files Browse the repository at this point in the history
Signed-off-by: Jan Luebbe <jlu@pengutronix.de>
  • Loading branch information
jluebbe committed Aug 6, 2019
1 parent f8c5df6 commit ba67f0b
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 2 deletions.
16 changes: 15 additions & 1 deletion man/labgrid-client.1
Expand Up @@ -79,6 +79,10 @@ Various labgrid\-client commands use the following environment variable:
.SS LG_PLACE
.sp
This variable can be used to specify a place without using the \fB\-p\fP option, the \fB\-p\fP option overrides it.
.SS LG_TOKEN
.sp
This variable can be used to specify a reservation for the \fBwait\fP command and
for the \fB+\fP place expansion.
.SS LG_STATE
.sp
This variable can be used to specify a state which the device transitions into
Expand Down Expand Up @@ -130,6 +134,8 @@ matches anything.
.sp
\fBset\-comment\fP comment Update or set the place comment
.sp
\fBset\-tags\fP comment Set place tags (key=value)
.sp
\fBadd\-match\fP match Add one (or multiple) match pattern(s) to a place, see MATCHES
.sp
\fBdel\-match\fP match Delete one (or multiple) match pattern(s) from a place, see MATCHES
Expand Down Expand Up @@ -164,7 +170,15 @@ matches anything.
.sp
\fBtmc\fP command Control a USB TMC device
.sp
\fBwrite\-image\fP Write images onto block devices (USBSDMux, USB Sticks, …)
\fBwrite\-image\fP Write images onto block devices (USBSDMux, USB Sticks, …)
.sp
\fBreserve\fP filter Create a reservation
.sp
\fBcancel\-reservation\fP token Cancel a pending reservation
.sp
\fBwait\fP token Wait for a reservation to be allocated
.sp
\fBreservations\fP List current reservations
.SH EXAMPLES
.sp
To retrieve a list of places run:
Expand Down
18 changes: 17 additions & 1 deletion man/labgrid-client.rst
Expand Up @@ -64,6 +64,11 @@ LG_PLACE
~~~~~~~~
This variable can be used to specify a place without using the ``-p`` option, the ``-p`` option overrides it.

LG_TOKEN
~~~~~~~~
This variable can be used to specify a reservation for the ``wait`` command and
for the ``+`` place expansion.

LG_STATE
~~~~~~~~
This variable can be used to specify a state which the device transitions into
Expand Down Expand Up @@ -121,6 +126,8 @@ LABGRID-CLIENT COMMANDS

``set-comment`` comment Update or set the place comment

``set-tags`` comment Set place tags (key=value)

``add-match`` match Add one (or multiple) match pattern(s) to a place, see MATCHES

``del-match`` match Delete one (or multiple) match pattern(s) from a place, see MATCHES
Expand Down Expand Up @@ -155,7 +162,16 @@ LABGRID-CLIENT COMMANDS

``tmc`` command Control a USB TMC device

``write-image`` Write images onto block devices (USBSDMux, USB Sticks, …)
``write-image`` Write images onto block devices (USBSDMux, USB Sticks, …)

``reserve`` filter Create a reservation

``cancel-reservation`` token Cancel a pending reservation

``wait`` token Wait for a reservation to be allocated

``reservations`` List current reservations


EXAMPLES
--------
Expand Down

0 comments on commit ba67f0b

Please sign in to comment.