Skip to content
Permalink
Browse files

doc: add snippets for labgrid-suggest

Eventually we'll want a man page which reflects the proper usage, but at
least add some notes about it for now.

Signed-off-by: Rouven Czerwinski <r.czerwinski@pengutronix.de>
  • Loading branch information
Emantor committed Nov 4, 2019
1 parent 7a0c08f commit b4c43c64edfcc5a5dc5795c3ac687054725cdbdf
Showing with 5 additions and 0 deletions.
  1. +5 −0 doc/getting_started.rst
@@ -215,6 +215,9 @@ For example, to export a ``USBSerialPort`` with ``ID_SERIAL_SHORT`` of
USBSerialPort:
ID_SERIAL_SHORT: ID23421JLK
.. note:: Use ``labgrid-suggest`` to generate the YAML snippets for most
exportable resources.

The exporter can now be started by running:

.. code-block:: bash
@@ -319,6 +322,8 @@ The udev resources become available to the test/exporter as soon es they are
plugged into the computer, e.g. allowing an exporter to export all USB ports on
a specific hub and making a ``NetworkSerialPort`` available as soon as it is
plugged into one of the hub's ports.
Labgrid also provides a small utility called ``labgrid-suggest`` which will
output the proper YAML formatted snippets for you.
The information udev has on a device can be viewed by executing:

.. code-block:: bash

0 comments on commit b4c43c6

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