[PATCH v1 1/1] ShellPkg/Ping6: Add a note in help for TargetIp

[PATCH v1 1/1] ShellPkg/Ping6: Add a note in help for TargetIp

[hegdenag]

'Ping6 TargetIp' is a valid command input but we bail out
when TargetIp is a link local address because we would want
the user to specify the NIC (via SourceIp) through which
he/she would want to ping to TargetIp. This patch updates
the help text to mention the same.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Hegde Nagaraj P <nagaraj-p.hegde@hpe.com>
---
 ShellPkg/Library/UefiShellNetwork2CommandsLib/UefiShellNetwork2CommandsLib.uni | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/ShellPkg/Library/UefiShellNetwork2CommandsLib/UefiShellNetwork2CommandsLib.uni b/ShellPkg/Library/UefiShellNetwork2CommandsLib/UefiShellNetwork2CommandsLib.uni
index 8f27e27..5adc5b5 100644
--- a/ShellPkg/Library/UefiShellNetwork2CommandsLib/UefiShellNetwork2CommandsLib.uni
+++ b/ShellPkg/Library/UefiShellNetwork2CommandsLib/UefiShellNetwork2CommandsLib.uni
@@ -99,6 +99,8 @@
 "  -n count    Send request count, (default=10, min=1, max=10000).\r\n"
 "  -s SourceIp Source IPv6 address.\r\n"
 "  TargetIp    Target IPv6 address.\r\n"
+"NOTES:\r\n"
+"  1. When TargetIp is a link local address, SourceIp needs to be specified.\r\n"
 ".SH EXAMPLES\r\n"
 " \r\n"
 "Examples:\r\n"
-- 
2.8.3.windows.1

Re: [PATCH v1 1/1] ShellPkg/Ping6: Add a note in help for TargetIp

[Carsey, Jaben]

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

> -----Original Message-----
> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of
> hegdenag
> Sent: Monday, November 07, 2016 12:41 AM
> To: edk2-devel@lists.01.org
> Cc: Carsey, Jaben <jaben.carsey@intel.com>; Ni, Ruiyu
> <ruiyu.ni@intel.com>; Wu, Jiaxin <jiaxin.wu@intel.com>
> Subject: [edk2] [PATCH v1 1/1] ShellPkg/Ping6: Add a note in help for
> TargetIp
> Importance: High
> 
> 'Ping6 TargetIp' is a valid command input but we bail out
> when TargetIp is a link local address because we would want
> the user to specify the NIC (via SourceIp) through which
> he/she would want to ping to TargetIp. This patch updates
> the help text to mention the same.
> 
> Contributed-under: TianoCore Contribution Agreement 1.0
> Signed-off-by: Hegde Nagaraj P <nagaraj-p.hegde@hpe.com>
> ---
> 
> ShellPkg/Library/UefiShellNetwork2CommandsLib/UefiShellNetwork2Comm
> andsLib.uni | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git
> a/ShellPkg/Library/UefiShellNetwork2CommandsLib/UefiShellNetwork2Com
> mandsLib.uni
> b/ShellPkg/Library/UefiShellNetwork2CommandsLib/UefiShellNetwork2Com
> mandsLib.uni
> index 8f27e27..5adc5b5 100644
> ---
> a/ShellPkg/Library/UefiShellNetwork2CommandsLib/UefiShellNetwork2Com
> mandsLib.uni
> +++
> b/ShellPkg/Library/UefiShellNetwork2CommandsLib/UefiShellNetwork2Com
> mandsLib.uni
> @@ -99,6 +99,8 @@
>  "  -n count    Send request count, (default=10, min=1, max=10000).\r\n"
>  "  -s SourceIp Source IPv6 address.\r\n"
>  "  TargetIp    Target IPv6 address.\r\n"
> +"NOTES:\r\n"
> +"  1. When TargetIp is a link local address, SourceIp needs to be
> specified.\r\n"
>  ".SH EXAMPLES\r\n"
>  " \r\n"
>  "Examples:\r\n"
> --
> 2.8.3.windows.1
> 
> _______________________________________________
> edk2-devel mailing list
> edk2-devel@lists.01.org
> https://lists.01.org/mailman/listinfo/edk2-devel

Re: [PATCH v1 1/1] ShellPkg/Ping6: Add a note in help for TargetIp

[Wu, Jiaxin]

Looks good to me.

Reviewed-By: Wu Jiaxin <jiaxin.wu@intel.com>

Best Regards!
Jiaxin

> -----Original Message-----
> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of
> hegdenag
> Sent: Monday, November 7, 2016 4:41 PM
> To: edk2-devel@lists.01.org
> Cc: Carsey, Jaben <jaben.carsey@intel.com>; Ni, Ruiyu <ruiyu.ni@intel.com>;
> Wu, Jiaxin <jiaxin.wu@intel.com>
> Subject: [edk2] [PATCH v1 1/1] ShellPkg/Ping6: Add a note in help for TargetIp
> 
> 'Ping6 TargetIp' is a valid command input but we bail out when TargetIp is a
> link local address because we would want the user to specify the NIC (via
> SourceIp) through which he/she would want to ping to TargetIp. This patch
> updates the help text to mention the same.
> 
> Contributed-under: TianoCore Contribution Agreement 1.0
> Signed-off-by: Hegde Nagaraj P <nagaraj-p.hegde@hpe.com>
> ---
> 
> ShellPkg/Library/UefiShellNetwork2CommandsLib/UefiShellNetwork2Command
> sLib.uni | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git
> a/ShellPkg/Library/UefiShellNetwork2CommandsLib/UefiShellNetwork2Comma
> ndsLib.uni
> b/ShellPkg/Library/UefiShellNetwork2CommandsLib/UefiShellNetwork2Comma
> ndsLib.uni
> index 8f27e27..5adc5b5 100644
> ---
> a/ShellPkg/Library/UefiShellNetwork2CommandsLib/UefiShellNetwork2Comma
> ndsLib.uni
> +++
> b/ShellPkg/Library/UefiShellNetwork2CommandsLib/UefiShellNetwork2Com
> +++ mandsLib.uni
> @@ -99,6 +99,8 @@
>  "  -n count    Send request count, (default=10, min=1, max=10000).\r\n"
>  "  -s SourceIp Source IPv6 address.\r\n"
>  "  TargetIp    Target IPv6 address.\r\n"
> +"NOTES:\r\n"
> +"  1. When TargetIp is a link local address, SourceIp needs to be specified.\r\n"
>  ".SH EXAMPLES\r\n"
>  " \r\n"
>  "Examples:\r\n"
> --
> 2.8.3.windows.1
> 
> _______________________________________________
> edk2-devel mailing list
> edk2-devel@lists.01.org
> https://lists.01.org/mailman/listinfo/edk2-devel