Re: [PATCH] ShellPkg: Correct a parameter's name

["Zhang, Shenglei" <shenglei.zhang@intel.com>]

Hi Jaben,

Do you have any opinion on "fs-path" rename to "file-full-path-name"?

Thanks,
Shenglei

From: krishnaLee [mailto:sssky307@163.com]
Sent: Thursday, February 21, 2019 10:00 AM
To: Zhang, Shenglei <shenglei.zhang@intel.com>
Cc: edk2-devel@lists.01.org
Subject: Re:[edk2] [PATCH] ShellPkg: Correct a parameter's name


Hi Shenglei,
I am confused some times,see UEFI_Shell_specification_2_2,chapter-3.7:

3.7 File Names
The UEFI Shell supports file names and paths with the following format:
fs-path := [fs-map-name] [fs-divider][fs-dirs][fs-name]

May be if the define name "fs-path" rename to "file-full-path-name" is more clear,:)

thanks,
krishna.



At 2019-02-21 09:28:07, "Shenglei Zhang" <shenglei.zhang@intel.com<mailto:shenglei.zhang@intel.com>> wrote:

>The parameter FilePath of ShellOpenFileByName defined in

>ShellLib.h is incorrect. It should be FileName.

>https://bugzilla.tianocore.org/show_bug.cgi?id=1221

>

>Cc: Jaben Carsey <jaben.carsey@intel.com<mailto:jaben.carsey@intel.com>>

>Cc: Ruiyu Ni <ruiyu.ni@intel.com<mailto:ruiyu.ni@intel.com>>

>Contributed-under: TianoCore Contribution Agreement 1.1

>Signed-off-by: shenglei <shenglei.zhang@intel.com<mailto:shenglei.zhang@intel.com>>

>---

> ShellPkg/Include/Library/ShellLib.h | 4 ++--

> 1 file changed, 2 insertions(+), 2 deletions(-)

>

>diff --git a/ShellPkg/Include/Library/ShellLib.h b/ShellPkg/Include/Library/ShellLib.h

>index 2ecc5ee006..78bdcc8c53 100644

>--- a/ShellPkg/Include/Library/ShellLib.h

>+++ b/ShellPkg/Include/Library/ShellLib.h

>@@ -161,7 +161,7 @@ ShellOpenFileByDevicePath(

>   otherwise, the Filehandle is NULL. Attributes is valid only for

>   EFI_FILE_MODE_CREATE.

>

>-  @param[in] FilePath           The pointer to file name.

>+  @param[in] FileName           The pointer to file name.

>   @param[out] FileHandle        The pointer to the file handle.

>   @param[in] OpenMode           The mode to open the file with.

>   @param[in] Attributes         The file's file attributes.

>@@ -186,7 +186,7 @@ ShellOpenFileByDevicePath(

> EFI_STATUS

> EFIAPI

> ShellOpenFileByName(

>-  IN CONST CHAR16               *FilePath,

>+  IN CONST CHAR16               *FileName,

>   OUT SHELL_FILE_HANDLE         *FileHandle,

>   IN UINT64                     OpenMode,

>   IN UINT64                     Attributes

>--

>2.18.0.windows.1

>

>_______________________________________________

>edk2-devel mailing list

>edk2-devel@lists.01.org<mailto:edk2-devel@lists.01.org>

>https://lists.01.org/mailman/listinfo/edk2-devel