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 <[email protected]>
labgrid-project · May 21, 2024 · 88f1ba7 · 88f1ba7
1 parent 9e0562e
commit 88f1ba7
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/doc/development.rst b/doc/development.rst
@@ -304,6 +304,12 @@ while the `shell` state uses the barebox state to cycle the board and then boot
 the linux kernel.
 The `off` state switches the power off.
 
+Oftentimes it is also necessary to wait for specific resources to appear before
+a transition can be continued. The `await_resources` function of the target
+implements this functionality, it expects a list of resources to wait for and
+optionally takes a timeout and whether the resource should be available or
+unavailable.
+
 
 Tips for Writing and Debugging Tests
 ------------------------------------