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

Hao Wu posted 3 patches 7 years, 8 months ago
[edk2] [PATCH 1/3] MdePkg/BasePrintLib: Refine the comment for AsciiValueToStringS API
Posted by Hao Wu 7 years, 8 months ago
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

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel