Skip to content

Commit

Permalink
doc/configuration: UUUDriver: align example with reality
Browse files Browse the repository at this point in the history
Besides the image name, the UUUDriver supports a script attribute.
This is described in the Arguments: section, but not in the example,
which uses the non-existent cmd attribute instead.

Fix that and while at it, correctly indicate that script is optional.
Omitting it will just remove the -b $script from the uuu invocation.

Signed-off-by: Ahmad Fatoum <[email protected]>
  • Loading branch information
a3f committed Apr 24, 2024
1 parent b61bf55 commit 9288213
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2493,15 +2493,15 @@ Implements:
drivers:
UUUDriver:
image: 'mybootloaderkey'
cmd: 'spl'
script: 'spl'
images:
mybootloaderkey: 'path/to/mybootloader.img'
Arguments:
- image (str): optional, key in :ref:`images <labgrid-device-config-images>` containing the path
of an image to bootstrap onto the target
- script (str): run built-in script with ``uuu -b``, called with image as arg0
- script (str): optional, run built-in script with ``uuu -b``, called with image as arg0

USBStorageDriver
~~~~~~~~~~~~~~~~
Expand Down

0 comments on commit 9288213

Please sign in to comment.