Skip to content

Commit 67def55

Browse files
committed
doc: add links to config formats in getting_started
I was struggeling to understand the config file formats after reading getting_started. Only after a while, I found the documentation about the file formats. Now, getting_started has clear references to the corresponding sections in the configuration page. Signed-off-by: Leonardo Mörlein <[email protected]>
1 parent 9bbaf9f commit 67def55

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

doc/configuration.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3551,6 +3551,8 @@ The logger can be stopped with a call to the stop function:
35513551
Stopping the StepLogger if it has not been started will raise an
35523552
AssertionError, as will starting an already started StepLogger.
35533553

3554+
.. _environment-configuration:
3555+
35543556
Environment Configuration
35553557
-------------------------
35563558
The environment configuration for a test environment consists of a YAML file
@@ -3693,6 +3695,8 @@ See the :ref:`labgrid-device-config` man page for documentation on the
36933695
top-level ``options``, ``images``, ``tools``, and ``examples`` keys in the
36943696
environment configuration.
36953697

3698+
.. _exporter-configuration:
3699+
36963700
Exporter Configuration
36973701
----------------------
36983702
The exporter is configured by using a YAML file (with a syntax similar to the

doc/getting_started.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ Start by copying the initial example:
112112
113113
Connect your embedded board (raspberry pi, riotboard, …) to your computer and
114114
adjust the ``port`` parameter of the ``RawSerialPort`` resource and ``username``
115-
and ``password`` of the ShellDriver driver in ``local.yaml``:
115+
and ``password`` of the ShellDriver driver in the environment file ``local.yaml``:
116116

117117
.. code-block:: yaml
118118
@@ -130,6 +130,8 @@ and ``password`` of the ShellDriver driver in ``local.yaml``:
130130
login_prompt: ' login: '
131131
username: 'root'
132132
133+
More information about the environment configuration file can be found
134+
:ref:`here <environment-configuration>`.
133135

134136
You can check which device name gets assigned to your USB-Serial converter by
135137
unplugging the converter, running ``dmesg -w`` and plugging it back in. Boot up
@@ -187,7 +189,7 @@ The exporter needs a configuration file written in YAML syntax, listing
187189
the resources to be exported from the local machine.
188190
The config file contains one or more named resource groups.
189191
Each group contains one or more resource declarations and optionally a location
190-
string (see the :doc:`configuration reference <configuration>` for details).
192+
string.
191193

192194
For example, to export a ``USBSerialPort`` with ``ID_SERIAL_SHORT`` of
193195
``ID23421JLK``, the group name `example-group` and the location
@@ -237,6 +239,9 @@ Additional groups and resources can be added:
237239
match:
238240
ID_SERIAL_SHORT: KSLAH2341J
239241
242+
More information about the exporter configuration file can be found
243+
:ref:`here <exporter-configuration>`.
244+
240245
Restart the exporter to activate the new configuration.
241246

242247
.. Attention::

0 commit comments

Comments
 (0)