public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
* [PATCH] ShellPkg: Correct a parameter's name
@ 2019-02-21  1:28 Shenglei Zhang
  2019-02-21  2:00 ` krishnaLee
  0 siblings, 1 reply; 5+ messages in thread
From: Shenglei Zhang @ 2019-02-21  1:28 UTC (permalink / raw)
  To: edk2-devel; +Cc: Jaben Carsey, Ruiyu Ni, shenglei

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>
Cc: Ruiyu Ni <ruiyu.ni@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: shenglei <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



^ permalink raw reply related	[flat|nested] 5+ messages in thread

* Re: [PATCH] ShellPkg: Correct a parameter's name
  2019-02-21  1:28 [PATCH] ShellPkg: Correct a parameter's name Shenglei Zhang
@ 2019-02-21  2:00 ` krishnaLee
  2019-02-26  1:47   ` Zhang, Shenglei
  0 siblings, 1 reply; 5+ messages in thread
From: krishnaLee @ 2019-02-21  2:00 UTC (permalink / raw)
  To: Shenglei Zhang; +Cc: edk2-devel



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> 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>
>Cc: Ruiyu Ni <ruiyu.ni@intel.com>
>Contributed-under: TianoCore Contribution Agreement 1.1
>Signed-off-by: shenglei <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
>https://lists.01.org/mailman/listinfo/edk2-devel
\x16&#65533;&

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] ShellPkg: Correct a parameter's name
  2019-02-21  2:00 ` krishnaLee
@ 2019-02-26  1:47   ` Zhang, Shenglei
  0 siblings, 0 replies; 5+ messages in thread
From: Zhang, Shenglei @ 2019-02-26  1:47 UTC (permalink / raw)
  To: krishnaLee, Carsey, Jaben; +Cc: edk2-devel@lists.01.org

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


^ permalink raw reply	[flat|nested] 5+ messages in thread

* [PATCH] ShellPkg: Correct a parameter's name
@ 2019-03-05  2:05 Shenglei Zhang
  2019-03-05 15:21 ` Carsey, Jaben
  0 siblings, 1 reply; 5+ messages in thread
From: Shenglei Zhang @ 2019-03-05  2:05 UTC (permalink / raw)
  To: edk2-devel; +Cc: Jaben Carsey, Ruiyu Ni

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>
Cc: Ruiyu Ni <ruiyu.ni@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Shenglei Zhang <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



^ permalink raw reply related	[flat|nested] 5+ messages in thread

* Re: [PATCH] ShellPkg: Correct a parameter's name
  2019-03-05  2:05 Shenglei Zhang
@ 2019-03-05 15:21 ` Carsey, Jaben
  0 siblings, 0 replies; 5+ messages in thread
From: Carsey, Jaben @ 2019-03-05 15:21 UTC (permalink / raw)
  To: Zhang, Shenglei, edk2-devel@lists.01.org

Reviewed-by: Jaben Carsey <jaben.carsey@intel.com>

> -----Original Message-----
> From: Zhang, Shenglei
> Sent: Monday, March 04, 2019 6:06 PM
> To: edk2-devel@lists.01.org
> Cc: Carsey, Jaben <jaben.carsey@intel.com>; Ni, Ray <ray.ni@intel.com>
> Subject: [PATCH] ShellPkg: Correct a parameter's name
> Importance: High
> 
> 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>
> Cc: Ruiyu Ni <ruiyu.ni@intel.com>
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Shenglei Zhang <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



^ permalink raw reply	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2019-03-05 15:21 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2019-02-21  1:28 [PATCH] ShellPkg: Correct a parameter's name Shenglei Zhang
2019-02-21  2:00 ` krishnaLee
2019-02-26  1:47   ` Zhang, Shenglei
  -- strict thread matches above, loose matches on Subject: below --
2019-03-05  2:05 Shenglei Zhang
2019-03-05 15:21 ` Carsey, Jaben

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox