From a6f63a9402b63efe4441cd3de9d06bf8af7d1237 Mon Sep 17 00:00:00 2001 From: Rouven Czerwinski Date: Fri, 3 May 2024 10:12:30 +0200 Subject: [PATCH] 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 --- doc/development.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/development.rst b/doc/development.rst index 1b099a825..8b832f757 100644 --- 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 ------------------------------------