Skip to content
Permalink
Browse files

man: document add-named-match

Minimal viable documentation to use named matches in the man page.

Fixes #346

Signed-off-by: Rouven Czerwinski <r.czerwinski@pengutronix.de>
  • Loading branch information...
Emantor committed Sep 20, 2019
1 parent bff30ee commit e7dfa6c22bacd85cbbc9a02aacd6e4af5234eeb0
Showing with 16 additions and 0 deletions.
  1. +8 −0 man/labgrid-client.1
  2. +8 −0 man/labgrid-client.rst
@@ -179,6 +179,14 @@ matches anything.
\fBwait\fP token Wait for a reservation to be allocated
.sp
\fBreservations\fP List current reservations
.SH ADDING NAMED RESOURCES
.sp
If a target contains multiple Resources of the same type, named matches need to
be used to address the individual resources. In addition to the \fImatch\fP taken by
\fIadd\-match\fP, \fIadd\-named\-match\fP also takes a name for the resource. The other
client commands support the name as an optional parameter and will inform the
user that a name is required if multiple resources are found, but no name is
given.
.SH EXAMPLES
.sp
To retrieve a list of places run:
@@ -172,6 +172,14 @@ LABGRID-CLIENT COMMANDS

``reservations`` List current reservations

ADDING NAMED RESOURCES
----------------------
If a target contains multiple Resources of the same type, named matches need to
be used to address the individual resources. In addition to the `match` taken by
`add-match`, `add-named-match` also takes a name for the resource. The other
client commands support the name as an optional parameter and will inform the
user that a name is required if multiple resources are found, but no name is
given.

EXAMPLES
--------

0 comments on commit e7dfa6c

Please sign in to comment.
You can’t perform that action at this time.