diff options
| author | Heinrich Schuchardt <xypron.glpk@gmx.de> | 2018-09-12 19:00:02 +0200 |
|---|---|---|
| committer | Alexander Graf <agraf@suse.de> | 2018-09-23 21:55:30 +0200 |
| commit | 050cea770a873bc2d9210fb04c4db8fadbaa69ff (patch) | |
| tree | cbcc9a9fcfbf8fbdd0782a18b134f1822c27dcd8 /lib/efi_loader | |
| parent | 143acd1ef12e8834548b8434fa4a4ca160f4cd23 (diff) | |
efi_loader: provide description of file_open()
Replace urban slang by proper description.
Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
Signed-off-by: Alexander Graf <agraf@suse.de>
Diffstat (limited to 'lib/efi_loader')
| -rw-r--r-- | lib/efi_loader/efi_file.c | 14 |
1 files changed, 12 insertions, 2 deletions
diff --git a/lib/efi_loader/efi_file.c b/lib/efi_loader/efi_file.c index 92ca444617..9ba7673fb6 100644 --- a/lib/efi_loader/efi_file.c +++ b/lib/efi_loader/efi_file.c @@ -127,8 +127,18 @@ static int sanitize_path(char *path) return 0; } -/* NOTE: despite what you would expect, 'file_name' is actually a path. - * With windoze style backlashes, ofc. +/** + * file_open() - open a file handle + * + * @fs: file system + * @parent: directory relative to which the file is to be opened + * @file_name: path of the file to be opened. '\', '.', or '..' may + * be used as modifiers. A leading backslash indicates an + * absolute path. + * @mode: bit mask indicating the access mode (read, write, + * create) + * @attributes: attributes for newly created file + * Returns: handle to the opened file or NULL */ static struct efi_file_handle *file_open(struct file_system *fs, struct file_handle *parent, s16 *file_name, u64 mode, |