[PATCH 0/3] Refine the comment for AsciiValueToStringS

[PATCH 0/3] Refine the comment for AsciiValueToStringS

[Hao Wu]

The series will refine the comment description for:
1. PrintLib API AsciiValueToStringS
2. EFI_PRINT2S_PROTOCOL service ASCII_VALUE_TO_STRING_S

They will not ASSERT when the input/output parameter 'Buffer' is not
aligned on a 16-bit boundary.

Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Cc: Michael Kinney <michael.d.kinney@intel.com>

Hao Wu (3):
  MdePkg/BasePrintLib: Refine the comment for AsciiValueToStringS API
  MdeModulePkg/PrintLib: Refine the comment for AsciiValueToStringS API
  MdeModulePkg/Print2: Refine the comment for ASCII_VALUE_TO_STRING_S

 MdeModulePkg/Include/Protocol/Print2.h                    | 3 +--
 MdeModulePkg/Library/DxePrintLibPrint2Protocol/PrintLib.c | 3 +--
 MdePkg/Include/Library/PrintLib.h                         | 3 +--
 MdePkg/Library/BasePrintLib/PrintLib.c                    | 3 +--
 4 files changed, 4 insertions(+), 8 deletions(-)

-- 
2.12.0.windows.1

[PATCH 1/3] MdePkg/BasePrintLib: Refine the comment for AsciiValueToStringS API

[Hao Wu]

The commit refines the comment description for PrintLib API
AsciiValueToStringS.

This API will not ASSERT when the input/output parameter 'Buffer' is not
aligned on a 16-bit boundary.

Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Cc: Michael Kinney <michael.d.kinney@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Hao Wu <hao.a.wu@intel.com>
---
 MdePkg/Include/Library/PrintLib.h      | 3 +--
 MdePkg/Library/BasePrintLib/PrintLib.c | 3 +--
 2 files changed, 2 insertions(+), 4 deletions(-)

diff --git a/MdePkg/Include/Library/PrintLib.h b/MdePkg/Include/Library/PrintLib.h
index 9fe3609980..80a4fd21d3 100644
--- a/MdePkg/Include/Library/PrintLib.h
+++ b/MdePkg/Include/Library/PrintLib.h
@@ -967,8 +967,7 @@ AsciiValueToString (
   sign character, '0' characters, digit characters for Value, and the
   Null-terminator add up to Width characters.
 
-  If Buffer is not aligned on a 16-bit boundary, then ASSERT().
-  If an error would be returned, then the function will also ASSERT().
+  If an error would be returned, then the function will ASSERT().
 
   @param  Buffer      The pointer to the output buffer for the produced
                       Null-terminated Ascii string.
diff --git a/MdePkg/Library/BasePrintLib/PrintLib.c b/MdePkg/Library/BasePrintLib/PrintLib.c
index 7453e952a7..34793919f6 100644
--- a/MdePkg/Library/BasePrintLib/PrintLib.c
+++ b/MdePkg/Library/BasePrintLib/PrintLib.c
@@ -869,8 +869,7 @@ AsciiValueToString (
   sign character, '0' characters, digit characters for Value, and the
   Null-terminator add up to Width characters.
 
-  If Buffer is not aligned on a 16-bit boundary, then ASSERT().
-  If an error would be returned, then the function will also ASSERT().
+  If an error would be returned, then the function will ASSERT().
 
   @param  Buffer      The pointer to the output buffer for the produced
                       Null-terminated Ascii string.
-- 
2.12.0.windows.1

[PATCH 2/3] MdeModulePkg/PrintLib: Refine the comment for AsciiValueToStringS API

[Hao Wu]

The commit refines the comment description for PrintLib API
AsciiValueToStringS.

This API will not ASSERT when the input/output parameter 'Buffer' is not
aligned on a 16-bit boundary.

Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Cc: Michael Kinney <michael.d.kinney@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Hao Wu <hao.a.wu@intel.com>
---
 MdeModulePkg/Library/DxePrintLibPrint2Protocol/PrintLib.c | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/MdeModulePkg/Library/DxePrintLibPrint2Protocol/PrintLib.c b/MdeModulePkg/Library/DxePrintLibPrint2Protocol/PrintLib.c
index 6a4d25b73a..9f702c4fef 100644
--- a/MdeModulePkg/Library/DxePrintLibPrint2Protocol/PrintLib.c
+++ b/MdeModulePkg/Library/DxePrintLibPrint2Protocol/PrintLib.c
@@ -1173,8 +1173,7 @@ AsciiValueToString (
   sign character, '0' characters, digit characters for Value, and the
   Null-terminator add up to Width characters.
 
-  If Buffer is not aligned on a 16-bit boundary, then ASSERT().
-  If an error would be returned, then the function will also ASSERT().
+  If an error would be returned, then the function will ASSERT().
 
   @param  Buffer      The pointer to the output buffer for the produced
                       Null-terminated Ascii string.
-- 
2.12.0.windows.1

[PATCH 3/3] MdeModulePkg/Print2: Refine the comment for ASCII_VALUE_TO_STRING_S

[Hao Wu]

The commit refines the comment description for EFI_PRINT2S_PROTOCOL
service ASCII_VALUE_TO_STRING_S.

This service will not ASSERT when the input/output parameter 'Buffer' is
not aligned on a 16-bit boundary.

Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Cc: Michael Kinney <michael.d.kinney@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Hao Wu <hao.a.wu@intel.com>
---
 MdeModulePkg/Include/Protocol/Print2.h | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/MdeModulePkg/Include/Protocol/Print2.h b/MdeModulePkg/Include/Protocol/Print2.h
index e4dd6f2be5..61b574e78a 100644
--- a/MdeModulePkg/Include/Protocol/Print2.h
+++ b/MdeModulePkg/Include/Protocol/Print2.h
@@ -610,8 +610,7 @@ RETURN_STATUS
   sign character, '0' characters, digit characters for Value, and the
   Null-terminator add up to Width characters.
 
-  If Buffer is not aligned on a 16-bit boundary, then ASSERT().
-  If an error would be returned, then the function will also ASSERT().
+  If an error would be returned, then the function will ASSERT().
 
   @param  Buffer      The pointer to the output buffer for the produced
                       Null-terminated Ascii string.
-- 
2.12.0.windows.1

Re: [PATCH 0/3] Refine the comment for AsciiValueToStringS

[Gao, Liming]

Reviewed-by: Liming Gao <liming.gao@intel.com>

>-----Original Message-----
>From: Wu, Hao A
>Sent: Tuesday, March 07, 2017 4:16 PM
>To: edk2-devel@lists.01.org
>Cc: Wu, Hao A <hao.a.wu@intel.com>; Yao, Jiewen <jiewen.yao@intel.com>;
>Gao, Liming <liming.gao@intel.com>; Kinney, Michael D
><michael.d.kinney@intel.com>
>Subject: [PATCH 0/3] Refine the comment for AsciiValueToStringS
>
>The series will refine the comment description for:
>1. PrintLib API AsciiValueToStringS
>2. EFI_PRINT2S_PROTOCOL service ASCII_VALUE_TO_STRING_S
>
>They will not ASSERT when the input/output parameter 'Buffer' is not
>aligned on a 16-bit boundary.
>
>Cc: Jiewen Yao <jiewen.yao@intel.com>
>Cc: Liming Gao <liming.gao@intel.com>
>Cc: Michael Kinney <michael.d.kinney@intel.com>
>
>Hao Wu (3):
>  MdePkg/BasePrintLib: Refine the comment for AsciiValueToStringS API
>  MdeModulePkg/PrintLib: Refine the comment for AsciiValueToStringS API
>  MdeModulePkg/Print2: Refine the comment for
>ASCII_VALUE_TO_STRING_S
>
> MdeModulePkg/Include/Protocol/Print2.h                    | 3 +--
> MdeModulePkg/Library/DxePrintLibPrint2Protocol/PrintLib.c | 3 +--
> MdePkg/Include/Library/PrintLib.h                         | 3 +--
> MdePkg/Library/BasePrintLib/PrintLib.c                    | 3 +--
> 4 files changed, 4 insertions(+), 8 deletions(-)
>
>--
>2.12.0.windows.1