Skip to content

Commit 81f5801

Browse files
Bastian-KrauseBastian-Krause
committed
man: update for gRPC
Signed-off-by: Bastian Krause <bst@pengutronix.de> Signed-off-by: Rouven Czerwinski <r.czerwinski@pengutronix.de>
1 parent c613f1e commit 81f5801

10 files changed

Lines changed: 152 additions & 58 deletions

‎debian/labgrid.manpages‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
man/labgrid-client.1
2+
man/labgrid-coordinator.1
23
man/labgrid-exporter.1
34
man/labgrid-suggest.1
45
man/labgrid-device-config.5

‎man/Makefile‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
PAGES := labgrid-client.1 labgrid-exporter.1 labgrid-device-config.5 labgrid-pytest.7 labgrid-suggest.1
2-
COMPRESSED := labgrid-client.1.gz labgrid-exporter.1.gz labgrid-device-config.5.gz labgrid-pytest.7.gz labgrid-suggest.1.gz
1+
PAGES := labgrid-client.1 labgrid-coordinator.1 labgrid-exporter.1 labgrid-device-config.5 labgrid-pytest.7 labgrid-suggest.1
2+
COMPRESSED := labgrid-client.1.gz labgrid-coordinator.1.gz labgrid-exporter.1.gz labgrid-device-config.5.gz labgrid-pytest.7.gz labgrid-suggest.1.gz
33

44
%.1 %.5 %.7: %.rst
55
rst2man.py $< >$@.tmp

‎man/labgrid-client.1‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ display command line help
5151
.BI \-p \ PLACE\fR,\fB \ \-\-place \ PLACE
5252
specify the place to operate on
5353
.TP
54-
.BI \-x \ URL\fR,\fB \ \-\-crossbar \ URL
55-
the crossbar url of the coordinator, defaults to \fBws://127.0.0.1:20408/ws\fP
54+
.BI \-x \ ADDRESS\fR,\fB \ \-\-coordinator \ ADDRESS
55+
coordinator \fBHOST[:PORT]\fP to connect to, defaults to \fB127.0.0.1:20408\fP
5656
.TP
5757
.BI \-c \ CONFIG\fR,\fB \ \-\-config \ CONFIG
5858
set the configuration file
@@ -103,14 +103,10 @@ A desired state must be set using \fBLG_STATE\fP or \fB\-s\fP/\fB\-\-state\fP\&.
103103
.sp
104104
This variable can be used to specify the configuration file to use without
105105
using the \fB\-\-config\fP option, the \fB\-\-config\fP option overrides it.
106-
.SS LG_CROSSBAR
106+
.SS LG_COORDINATOR
107107
.sp
108-
This variable can be used to set the default crossbar URL (instead of using the
109-
\fB\-x\fP option).
110-
.SS LG_CROSSBAR_REALM
111-
.sp
112-
This variable can be used to set the default crossbar realm to use instead of
113-
\fBrealm1\fP\&.
108+
This variable can be used to set the default coordinator in the format
109+
\fBHOST[:PORT]\fP (instead of using the \fB\-x\fP option).
114110
.SS LG_PROXY
115111
.sp
116112
This variable can be used to specify a SSH proxy hostname which should be used

‎man/labgrid-client.rst‎

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ OPTIONS
3838
display command line help
3939
-p PLACE, --place PLACE
4040
specify the place to operate on
41-
-x URL, --crossbar URL
42-
the crossbar url of the coordinator, defaults to ``ws://127.0.0.1:20408/ws``
41+
-x ADDRESS, --coordinator ADDRESS
42+
coordinator ``HOST[:PORT]`` to connect to, defaults to ``127.0.0.1:20408``
4343
-c CONFIG, --config CONFIG
4444
set the configuration file
4545
-s STATE, --state STATE
@@ -91,15 +91,10 @@ LG_ENV
9191
This variable can be used to specify the configuration file to use without
9292
using the ``--config`` option, the ``--config`` option overrides it.
9393

94-
LG_CROSSBAR
95-
~~~~~~~~~~~
96-
This variable can be used to set the default crossbar URL (instead of using the
97-
``-x`` option).
98-
99-
LG_CROSSBAR_REALM
100-
~~~~~~~~~~~~~~~~~
101-
This variable can be used to set the default crossbar realm to use instead of
102-
``realm1``.
94+
LG_COORDINATOR
95+
~~~~~~~~~~~~~~
96+
This variable can be used to set the default coordinator in the format
97+
``HOST[:PORT]`` (instead of using the ``-x`` option).
10398

10499
LG_PROXY
105100
~~~~~~~~

‎man/labgrid-coordinator.1‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
.\" Man page generated from reStructuredText.
2+
.
3+
.
4+
.nr rst2man-indent-level 0
5+
.
6+
.de1 rstReportMargin
7+
\\$1 \\n[an-margin]
8+
level \\n[rst2man-indent-level]
9+
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
10+
-
11+
\\n[rst2man-indent0]
12+
\\n[rst2man-indent1]
13+
\\n[rst2man-indent2]
14+
..
15+
.de1 INDENT
16+
.\" .rstReportMargin pre:
17+
. RS \\$1
18+
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
19+
. nr rst2man-indent-level +1
20+
.\" .rstReportMargin post:
21+
..
22+
.de UNINDENT
23+
. RE
24+
.\" indent \\n[an-margin]
25+
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
26+
.nr rst2man-indent-level -1
27+
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
28+
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
29+
..
30+
.TH "LABGRID-COORDINATOR" 1 "2024-08-06" "0.0.1" "embedded testing"
31+
.SH NAME
32+
labgrid-coordinator \- labgrid-coordinator managing labgrid resources and places
33+
.SH SYNOPSIS
34+
.sp
35+
\fBlabgrid\-coordinator\fP \fB\-\-help\fP
36+
.SH DESCRIPTION
37+
.sp
38+
Labgrid is a scalable infrastructure and test architecture for embedded (linux)
39+
systems.
40+
.sp
41+
This is the man page for the coordinator. Clients and exporters connect to the
42+
coordinator to publish resources, manage place configuration and handle mutual
43+
exclusion.
44+
.SH OPTIONS
45+
.INDENT 0.0
46+
.TP
47+
.B \-h\fP,\fB \-\-help
48+
display command line help
49+
.TP
50+
.BI \-l \ ADDRESS\fR,\fB \ \-\-listen \ ADDRESS
51+
make coordinator listen on host and port
52+
.TP
53+
.B \-d\fP,\fB \-\-debug
54+
enable debug mode
55+
.UNINDENT
56+
.SH SEE ALSO
57+
.sp
58+
\fBlabgrid\-client\fP(1), \fBlabgrid\-exporter\fP(1)
59+
.SH AUTHOR
60+
Rouven Czerwinski <r.czerwinski@pengutronix.de>
61+
62+
Organization: Labgrid-Project
63+
.SH COPYRIGHT
64+
Copyright (C) 2016-2024 Pengutronix. This library is free software;
65+
you can redistribute it and/or modify it under the terms of the GNU
66+
Lesser General Public License as published by the Free Software
67+
Foundation; either version 2.1 of the License, or (at your option)
68+
any later version.
69+
.\" Generated by docutils manpage writer.
70+
.

‎man/labgrid-coordinator.rst‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
=====================
2+
labgrid-coordinator
3+
=====================
4+
5+
labgrid-coordinator managing labgrid resources and places
6+
=========================================================
7+
8+
9+
:Author: Rouven Czerwinski <r.czerwinski@pengutronix.de>
10+
:organization: Labgrid-Project
11+
:Date: 2024-08-06
12+
:Copyright: Copyright (C) 2016-2024 Pengutronix. This library is free software;
13+
you can redistribute it and/or modify it under the terms of the GNU
14+
Lesser General Public License as published by the Free Software
15+
Foundation; either version 2.1 of the License, or (at your option)
16+
any later version.
17+
:Version: 0.0.1
18+
:Manual section: 1
19+
:Manual group: embedded testing
20+
21+
22+
23+
SYNOPSIS
24+
--------
25+
26+
``labgrid-coordinator`` ``--help``
27+
28+
DESCRIPTION
29+
-----------
30+
Labgrid is a scalable infrastructure and test architecture for embedded (linux)
31+
systems.
32+
33+
This is the man page for the coordinator. Clients and exporters connect to the
34+
coordinator to publish resources, manage place configuration and handle mutual
35+
exclusion.
36+
37+
OPTIONS
38+
-------
39+
-h, --help
40+
display command line help
41+
-l ADDRESS, --listen ADDRESS
42+
make coordinator listen on host and port
43+
-d, --debug
44+
enable debug mode
45+
46+
SEE ALSO
47+
--------
48+
49+
``labgrid-client``\(1), ``labgrid-exporter``\(1)

‎man/labgrid-device-config.5‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -52,17 +52,13 @@ For a list of available resources and drivers refer to
5252
\fI\%https://labgrid.readthedocs.io/en/latest/configuration.html\fP\&.
5353
.SH OPTIONS
5454
.sp
55-
The \fBoptions:\fP top key configures various options such as the crossbar_url.
55+
The \fBoptions:\fP top key configures various options such as the coordinator_address.
5656
.SS OPTIONS KEYS
5757
.INDENT 0.0
5858
.TP
59-
.B \fBcrossbar_url\fP
60-
takes as parameter the URL of the crossbar (coordinator) to connect to.
61-
Defaults to \(aqws://127.0.0.1:20408\(aq.
62-
.TP
63-
.B \fBcrossbar_realm\fP
64-
takes as parameter the realm of the crossbar (coordinator) to connect to.
65-
Defaults to \(aqrealm1\(aq.
59+
.B \fBcoordinator_address\fP
60+
takes as parameter the coordinator \fBHOST[:PORT]\fP to connect to.
61+
Defaults to \fB127.0.0.1:20408\fP\&.
6662
.UNINDENT
6763
.SH IMAGES
6864
.sp

‎man/labgrid-device-config.rst‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -47,18 +47,14 @@ https://labgrid.readthedocs.io/en/latest/configuration.html.
4747

4848
OPTIONS
4949
-------
50-
The ``options:`` top key configures various options such as the crossbar_url.
50+
The ``options:`` top key configures various options such as the coordinator_address.
5151

5252
OPTIONS KEYS
5353
~~~~~~~~~~~~
5454

55-
``crossbar_url``
56-
takes as parameter the URL of the crossbar (coordinator) to connect to.
57-
Defaults to 'ws://127.0.0.1:20408'.
58-
59-
``crossbar_realm``
60-
takes as parameter the realm of the crossbar (coordinator) to connect to.
61-
Defaults to 'realm1'.
55+
``coordinator_address``
56+
takes as parameter the coordinator ``HOST[:PORT]`` to connect to.
57+
Defaults to ``127.0.0.1:20408``.
6258

6359
.. _labgrid-device-config-images:
6460

‎man/labgrid-exporter.1‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ USB devices and various other controllers.
4747
.B \-h\fP,\fB \-\-help
4848
display command line help
4949
.TP
50-
.B \-x\fP,\fB \-\-crossbar
51-
the crossbar url of the coordinator
50+
.B \-x\fP,\fB \-\-coordinator
51+
coordinator \fBHOST[:PORT]\fP to connect to, defaults to \fB127.0.0.1:20408\fP
5252
.TP
5353
.B \-i\fP,\fB \-\-isolated
5454
enable isolated mode (always request SSH forwards)
@@ -100,14 +100,10 @@ for more information.
100100
.SH ENVIRONMENT VARIABLES
101101
.sp
102102
The following environment variable can be used to configure labgrid\-exporter.
103-
.SS LG_CROSSBAR
103+
.SS LG_COORDINATOR
104104
.sp
105-
This variable can be used to set the default crossbar URL (instead of using the
106-
\fB\-x\fP option).
107-
.SS LG_CROSSBAR_REALM
108-
.sp
109-
This variable can be used to set the default crossbar realm to use instead of
110-
\fBrealm1\fP\&.
105+
This variable can be used to set the default coordinator in the format
106+
\fBHOST[:PORT]\fP (instead of using the \fB\-x\fP option).
111107
.SH EXAMPLES
112108
.sp
113109
Start the exporter with the configuration file \fImy\-config.yaml\fP:

‎man/labgrid-exporter.rst‎

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ OPTIONS
3838
-------
3939
-h, --help
4040
display command line help
41-
-x, --crossbar
42-
the crossbar url of the coordinator
41+
-x, --coordinator
42+
coordinator ``HOST[:PORT]`` to connect to, defaults to ``127.0.0.1:20408``
4343
-i, --isolated
4444
enable isolated mode (always request SSH forwards)
4545
-n, --name
@@ -92,15 +92,10 @@ ENVIRONMENT VARIABLES
9292
---------------------
9393
The following environment variable can be used to configure labgrid-exporter.
9494

95-
LG_CROSSBAR
96-
~~~~~~~~~~~
97-
This variable can be used to set the default crossbar URL (instead of using the
98-
``-x`` option).
99-
100-
LG_CROSSBAR_REALM
101-
~~~~~~~~~~~~~~~~~
102-
This variable can be used to set the default crossbar realm to use instead of
103-
``realm1``.
95+
LG_COORDINATOR
96+
~~~~~~~~~~~~~~
97+
This variable can be used to set the default coordinator in the format
98+
``HOST[:PORT]`` (instead of using the ``-x`` option).
10499

105100
EXAMPLES
106101
--------

0 commit comments

Comments
 (0)