[PATCH 1/1] efi_loader: improve description of efi_file_from_path()

Provide a description of the function's logic.
Signed-off-by: Heinrich Schuchardt heinrich.schuchardt@canonical.com --- lib/efi_loader/efi_file.c | 9 +++++++++ 1 file changed, 9 insertions(+)
diff --git a/lib/efi_loader/efi_file.c b/lib/efi_loader/efi_file.c index c96a7f7ca3..ae0ca6101b 100644 --- a/lib/efi_loader/efi_file.c +++ b/lib/efi_loader/efi_file.c @@ -1098,6 +1098,15 @@ static const struct efi_file_handle efi_file_handle_protocol = { /** * efi_file_from_path() - open file via device path * + * The device path @fp consist of the device path of the handle with the + * simple file system protocol and one or more file path device path nodes. + * The concatenation of all file path names provides the total file path. + * + * The code starts at the first file path node and tries to open that file or + * directory. If there is a succeding file path node, the code opens it relative + * to this directory and continues iterating until reaching the last file path + * node. + * * @fp: device path * Return: EFI_FILE_PROTOCOL for the file or NULL */

On Thu, 10 Nov 2022 at 15:14, Heinrich Schuchardt heinrich.schuchardt@canonical.com wrote:
Provide a description of the function's logic.
Signed-off-by: Heinrich Schuchardt heinrich.schuchardt@canonical.com
lib/efi_loader/efi_file.c | 9 +++++++++ 1 file changed, 9 insertions(+)
diff --git a/lib/efi_loader/efi_file.c b/lib/efi_loader/efi_file.c index c96a7f7ca3..ae0ca6101b 100644 --- a/lib/efi_loader/efi_file.c +++ b/lib/efi_loader/efi_file.c @@ -1098,6 +1098,15 @@ static const struct efi_file_handle efi_file_handle_protocol = { /**
- efi_file_from_path() - open file via device path
- The device path @fp consist of the device path of the handle with the
consists of
- simple file system protocol and one or more file path device path nodes.
- The concatenation of all file path names provides the total file path.
- The code starts at the first file path node and tries to open that file or
- directory. If there is a succeding file path node, the code opens it relative
- to this directory and continues iterating until reaching the last file path
- node.
*/
- @fp: device path
- Return: EFI_FILE_PROTOCOL for the file or NULL
-- 2.37.2
Reviewed-by: Ilias Apalodimas ilias.apalodimas@linaro.org
participants (2)
-
Heinrich Schuchardt
-
Ilias Apalodimas