Skip to content

Commit a6f63a9

Browse files
committed
doc/development: document await_resources
Document how await_resources inside a strategy can be used to wait for the availability of a resource. Signed-off-by: Rouven Czerwinski <r.czerwinski@pengutronix.de>
1 parent 41a19d4 commit a6f63a9

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

doc/development.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -304,6 +304,12 @@ while the `shell` state uses the barebox state to cycle the board and then boot
304304
the linux kernel.
305305
The `off` state switches the power off.
306306

307+
Oftentimes it is also necessary to wait for specific resources to appear before
308+
a transition can be continued. The `await_resources` function of the target
309+
implements this functionality, it expects a list of resources to wait for and
310+
optionally takes a timeout and whether the resource should be available or
311+
unavailable.
312+
307313

308314
Tips for Writing and Debugging Tests
309315
------------------------------------

0 commit comments

Comments
 (0)