diff mbox series

[50/71] bootstd: Update docs on bootmeth_try_file() for sandbox

Message ID 20221207085137.445249-51-sjg@chromium.org
State Superseded
Delegated to: Tom Rini
Headers show
Series bootstd: Allow migration from distro_bootcmd scripts | expand

Commit Message

Simon Glass Dec. 7, 2022, 8:51 a.m. UTC
Mention that this function is also used with a NULL block devices to
access files on the host, when using sandbox.

Update the comment on struct bootflow also.

Signed-off-by: Simon Glass <sjg@chromium.org>
---

 include/bootflow.h | 2 +-
 include/bootmeth.h | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
diff mbox series

Patch

diff --git a/include/bootflow.h b/include/bootflow.h
index 75f2064f47c..f77bfb6eace 100644
--- a/include/bootflow.h
+++ b/include/bootflow.h
@@ -39,7 +39,7 @@  enum bootflow_state_t {
  * @glob_node: Points to siblings in the global list (all bootdev)
  * @dev: Bootdevice device which produced this bootflow
  * @blk: Block device which contains this bootflow, NULL if this is a network
- *	device
+ *	device or sandbox 'host' device
  * @part: Partition number (0 for whole device)
  * @fs_type: Filesystem type (FS_TYPE...) if this is fixed by the media, else 0.
  *	For example, the sandbox host-filesystem bootdev sets this to
diff --git a/include/bootmeth.h b/include/bootmeth.h
index 50ded055f3f..ba9e3667e52 100644
--- a/include/bootmeth.h
+++ b/include/bootmeth.h
@@ -240,7 +240,7 @@  int bootmeth_set_order(const char *order_str);
  * caller before reading the file.
  *
  * @bflow: Information about file to try
- * @desc: Block descriptor to read from
+ * @desc: Block descriptor to read from (NULL for sandbox host)
  * @prefix: Filename prefix to prepend to @fname (NULL for none)
  * @fname: Filename to read
  * Return: 0 if OK, -ENOMEM if not enough memory to allocate bflow->fname,