[PATCH 0/2] Correct typo in command help

[PATCH 0/2] Correct typo in command help

[Ruiyu Ni]

Ruiyu Ni (2):
  ShellPkg/dh: Correct typo in help
  ShellPkg/disconnect: '-r' is not optional when disconnecting all

 .../UefiShellDriver1CommandsLib/UefiShellDriver1CommandsLib.uni     | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

-- 
2.12.2.windows.2

[PATCH 1/2] ShellPkg/dh: Correct typo in help

[Ruiyu Ni]

Help message of "dh" gives an example to display all handles
with "Image" protocol but actually "LoadedImage" protocol should
be used.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com>
Cc: Jaben Carsey <jaben.carsey@intel.com>
---
 .../UefiShellDriver1CommandsLib/UefiShellDriver1CommandsLib.uni       | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/ShellPkg/Library/UefiShellDriver1CommandsLib/UefiShellDriver1CommandsLib.uni b/ShellPkg/Library/UefiShellDriver1CommandsLib/UefiShellDriver1CommandsLib.uni
index e4bff68838..3804fa7d28 100644
--- a/ShellPkg/Library/UefiShellDriver1CommandsLib/UefiShellDriver1CommandsLib.uni
+++ b/ShellPkg/Library/UefiShellDriver1CommandsLib/UefiShellDriver1CommandsLib.uni
@@ -401,9 +401,9 @@
 "  * To display all handles with 'diskio' protocol:\r\n"
 "    Shell> dh -p diskio\r\n"
 " \r\n"
-"  * To display all handles with 'Image' protocol and break when the screen is\r\n"
+"  * To display all handles with 'LoadedImage' protocol and break when the screen is\r\n"
 "    full:\r\n"
-"    Shell> dh -p Image -b\r\n"
+"    Shell> dh -p LoadedImage -b\r\n"
 ".SH RETURNVALUES\r\n"
 " \r\n"
 "RETURN VALUES:\r\n"
-- 
2.12.2.windows.2

Re: [PATCH 1/2] ShellPkg/dh: Correct typo in help

[Carsey, Jaben]

Ray,

This text is taken directly from the shell spec.  Do we need to fix that also?

> -----Original Message-----
> From: Ni, Ruiyu
> Sent: Thursday, September 28, 2017 10:21 AM
> To: edk2-devel@lists.01.org
> Cc: Carsey, Jaben <jaben.carsey@intel.com>
> Subject: [PATCH 1/2] ShellPkg/dh: Correct typo in help
> Importance: High
> 
> Help message of "dh" gives an example to display all handles
> with "Image" protocol but actually "LoadedImage" protocol should
> be used.
> 
> Contributed-under: TianoCore Contribution Agreement 1.0
> Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com>
> Cc: Jaben Carsey <jaben.carsey@intel.com>
> ---
>  .../UefiShellDriver1CommandsLib/UefiShellDriver1CommandsLib.uni       | 4
> ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git
> a/ShellPkg/Library/UefiShellDriver1CommandsLib/UefiShellDriver1Command
> sLib.uni
> b/ShellPkg/Library/UefiShellDriver1CommandsLib/UefiShellDriver1Comman
> dsLib.uni
> index e4bff68838..3804fa7d28 100644
> ---
> a/ShellPkg/Library/UefiShellDriver1CommandsLib/UefiShellDriver1Command
> sLib.uni
> +++
> b/ShellPkg/Library/UefiShellDriver1CommandsLib/UefiShellDriver1Comman
> dsLib.uni
> @@ -401,9 +401,9 @@
>  "  * To display all handles with 'diskio' protocol:\r\n"
>  "    Shell> dh -p diskio\r\n"
>  " \r\n"
> -"  * To display all handles with 'Image' protocol and break when the screen
> is\r\n"
> +"  * To display all handles with 'LoadedImage' protocol and break when the
> screen is\r\n"
>  "    full:\r\n"
> -"    Shell> dh -p Image -b\r\n"
> +"    Shell> dh -p LoadedImage -b\r\n"
>  ".SH RETURNVALUES\r\n"
>  " \r\n"
>  "RETURN VALUES:\r\n"
> --
> 2.12.2.windows.2

Re: [PATCH 1/2] ShellPkg/dh: Correct typo in help

[Ni, Ruiyu]

Yes I think so.

Thanks/Ray

> -----Original Message-----
> From: Carsey, Jaben
> Sent: Friday, September 29, 2017 2:30 AM
> To: Ni, Ruiyu <ruiyu.ni@intel.com>; edk2-devel@lists.01.org
> Subject: RE: [PATCH 1/2] ShellPkg/dh: Correct typo in help
> 
> Ray,
> 
> This text is taken directly from the shell spec.  Do we need to fix that also?
> 
> > -----Original Message-----
> > From: Ni, Ruiyu
> > Sent: Thursday, September 28, 2017 10:21 AM
> > To: edk2-devel@lists.01.org
> > Cc: Carsey, Jaben <jaben.carsey@intel.com>
> > Subject: [PATCH 1/2] ShellPkg/dh: Correct typo in help
> > Importance: High
> >
> > Help message of "dh" gives an example to display all handles with
> > "Image" protocol but actually "LoadedImage" protocol should be used.
> >
> > Contributed-under: TianoCore Contribution Agreement 1.0
> > Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com>
> > Cc: Jaben Carsey <jaben.carsey@intel.com>
> > ---
> >  .../UefiShellDriver1CommandsLib/UefiShellDriver1CommandsLib.uni       | 4
> > ++--
> >  1 file changed, 2 insertions(+), 2 deletions(-)
> >
> > diff --git
> > a/ShellPkg/Library/UefiShellDriver1CommandsLib/UefiShellDriver1Command
> > sLib.uni
> > b/ShellPkg/Library/UefiShellDriver1CommandsLib/UefiShellDriver1Comman
> > dsLib.uni
> > index e4bff68838..3804fa7d28 100644
> > ---
> > a/ShellPkg/Library/UefiShellDriver1CommandsLib/UefiShellDriver1Command
> > sLib.uni
> > +++
> > b/ShellPkg/Library/UefiShellDriver1CommandsLib/UefiShellDriver1Comman
> > dsLib.uni
> > @@ -401,9 +401,9 @@
> >  "  * To display all handles with 'diskio' protocol:\r\n"
> >  "    Shell> dh -p diskio\r\n"
> >  " \r\n"
> > -"  * To display all handles with 'Image' protocol and break when the
> > screen is\r\n"
> > +"  * To display all handles with 'LoadedImage' protocol and break
> > +when the
> > screen is\r\n"
> >  "    full:\r\n"
> > -"    Shell> dh -p Image -b\r\n"
> > +"    Shell> dh -p LoadedImage -b\r\n"
> >  ".SH RETURNVALUES\r\n"
> >  " \r\n"
> >  "RETURN VALUES:\r\n"
> > --
> > 2.12.2.windows.2

[PATCH 2/2] ShellPkg/disconnect: '-r' is not optional when disconnecting all

[Ruiyu Ni]

Correct the help message to match that defined in Shell spec.
In 'DISCONNECT -r [-nc]' case, '-r' is not optional.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com>
Cc: Jaben Carsey <jaben.carsey@intel.com>
---
 .../Library/UefiShellDriver1CommandsLib/UefiShellDriver1CommandsLib.uni | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/ShellPkg/Library/UefiShellDriver1CommandsLib/UefiShellDriver1CommandsLib.uni b/ShellPkg/Library/UefiShellDriver1CommandsLib/UefiShellDriver1CommandsLib.uni
index 3804fa7d28..0120e4e065 100644
--- a/ShellPkg/Library/UefiShellDriver1CommandsLib/UefiShellDriver1CommandsLib.uni
+++ b/ShellPkg/Library/UefiShellDriver1CommandsLib/UefiShellDriver1CommandsLib.uni
@@ -308,7 +308,7 @@
 ".SH SYNOPSIS\r\n"
 " \r\n"
 "DISCONNECT DeviceHandle [DriverHandle [ChildHandle]] \r\n"
-"DISCONNECT [-r] [-nc] \r\n"
+"DISCONNECT -r [-nc] \r\n"
 ".SH OPTIONS\r\n"
 " \r\n"
 "NOTES:\r\n"
-- 
2.12.2.windows.2

Re: [PATCH 0/2] Correct typo in command help

[Carsey, Jaben]

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

> -----Original Message-----
> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of
> Ruiyu Ni
> Sent: Thursday, September 28, 2017 10:21 AM
> To: edk2-devel@lists.01.org
> Subject: [edk2] [PATCH 0/2] Correct typo in command help
> Importance: High
> 
> Ruiyu Ni (2):
>   ShellPkg/dh: Correct typo in help
>   ShellPkg/disconnect: '-r' is not optional when disconnecting all
> 
>  .../UefiShellDriver1CommandsLib/UefiShellDriver1CommandsLib.uni     | 6
> +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> --
> 2.12.2.windows.2
> 
> _______________________________________________
> edk2-devel mailing list
> edk2-devel@lists.01.org
> https://lists.01.org/mailman/listinfo/edk2-devel