Skip to content

Commit 3e09a79

Browse files
Bastian-KrauseEmantor
authored andcommitted
doc/configuration: restructure environment/exporter config chapters
Adding more headlines makes it easier to scan over these sections when searching for something. It also helps pointing people to these sections due to the HTML anchors available for headlines in the HTML version of the docs. Signed-off-by: Bastian Krause <bst@pengutronix.de>
1 parent 497b29d commit 3e09a79

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

doc/configuration.rst

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3752,6 +3752,12 @@ All the resources and drivers in this chapter have a YAML example snippet which
37523752
can simply be added (at the correct indentation level, one level deeper) to the
37533753
environment configuration.
37543754

3755+
See the :ref:`labgrid-device-config` man page for documentation on the
3756+
top-level ``options``, ``images``, ``tools``, and ``imports`` keys in the
3757+
environment configuration.
3758+
3759+
Multiple Drivers of the Same Type
3760+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
37553761
If you want to use multiple drivers of the same type, the resources and drivers
37563762
need to be lists, e.g:
37573763

@@ -3804,6 +3810,8 @@ To bind the correct driver to the correct resource, explicit ``name`` and
38043810
The property name for the binding (e.g. ``port`` in the example above) is
38053811
documented for each individual driver in this chapter.
38063812

3813+
Templating the Environment Configuration
3814+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
38073815
The YAML configuration file also supports templating for some substitutions,
38083816
these are:
38093817

@@ -3827,10 +3835,6 @@ would resolve the ``qemu_bin`` path relative to the ``BASE`` dir of the YAML
38273835
file and try to use the `RemotePlace`_ with the name set in the ``LG_PLACE``
38283836
environment variable.
38293837

3830-
See the :ref:`labgrid-device-config` man page for documentation on the
3831-
top-level ``options``, ``images``, ``tools``, and ``examples`` keys in the
3832-
environment configuration.
3833-
38343838
.. _exporter-configuration:
38353839

38363840
Exporter Configuration
@@ -3912,8 +3916,8 @@ to achieve the same effect:
39123916
match:
39133917
'@ID_PATH': 'pci-0000:05:00.0-usb-3-1.4'
39143918
3915-
Templating
3916-
~~~~~~~~~~
3919+
Templating the Exporter Configuration
3920+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
39173921
To reduce the amount of repeated declarations when many similar resources
39183922
need to be exported, the `Jinja2 template engine <http://jinja.pocoo.org/>`_
39193923
is used as a preprocessor for the configuration file:

0 commit comments

Comments
 (0)