Re: [Patch v1 1/1] MdeModulePkg: fix comments in BaseSortLib

["Zeng, Star" <star.zeng@intel.com>]

Reviewed-by: Star Zeng <star.zeng@intel.com>

-----Original Message-----
From: Carsey, Jaben 
Sent: Thursday, November 1, 2018 3:21 AM
To: edk2-devel@lists.01.org
Cc: Zeng, Star <star.zeng@intel.com>; Wang, Jian J <jian.j.wang@intel.com>
Subject: [Patch v1 1/1] MdeModulePkg: fix comments in BaseSortLib

The comments are incorrect for the base version of this lib.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Jaben Carsey <jaben.carsey@intel.com>
Cc: Star Zeng <star.zeng@intel.com>
Cc: Jian J Wang <jian.j.wang@intel.com>
---
 MdeModulePkg/Library/BaseSortLib/BaseSortLib.c | 22 ++++++++------------
 1 file changed, 9 insertions(+), 13 deletions(-)

diff --git a/MdeModulePkg/Library/BaseSortLib/BaseSortLib.c b/MdeModulePkg/Library/BaseSortLib/BaseSortLib.c
index ab8a60585ee2..8f30c00971eb 100644
--- a/MdeModulePkg/Library/BaseSortLib/BaseSortLib.c
+++ b/MdeModulePkg/Library/BaseSortLib/BaseSortLib.c
@@ -1,7 +1,7 @@
 /** @file
   Library used for sorting routines.
 
-  Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved. <BR>
+  Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved. 
+ <BR>
   This program and the accompanying materials
   are licensed and made available under the terms and conditions of the BSD License
   which accompanies this distribution.  The full text of the license may be found at @@ -193,14 +193,12 @@ DevicePathCompare (  }
 
 /**
-  Function to compare 2 strings without regard to case of the characters.
+  Not supported in Base version.
 
-  @param[in] Buffer1            Pointer to String to compare.
-  @param[in] Buffer2            Pointer to second String to compare.
+  @param[in] Buffer1  Ignored.
+  @param[in] Buffer2  Ignored.
 
-  @retval 0                     Buffer1 equal to Buffer2.
-  @return < 0                   Buffer1 is less than Buffer2.
-  @return > 0                   Buffer1 is greater than Buffer2.
+  ASSERT and return 0.
 **/
 INTN
 EFIAPI
@@ -215,14 +213,12 @@ StringNoCaseCompare (
 
 
 /**
-  Function to compare 2 strings.
+  Not supported in Base version.
 
-  @param[in] Buffer1            Pointer to String to compare (CHAR16**).
-  @param[in] Buffer2            Pointer to second String to compare (CHAR16**).
+  @param[in] Buffer1  Ignored.
+  @param[in] Buffer2  Ignored.
 
-  @retval 0                     Buffer1 equal to Buffer2.
-  @return < 0                   Buffer1 is less than Buffer2.
-  @return > 0                   Buffer1 is greater than Buffer2.
+  ASSERT and return 0.
 **/
 INTN
 EFIAPI
--
2.16.2.windows.1