public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: Jaben Carsey <jaben.carsey@intel.com>
To: edk2-devel@lists.01.org
Cc: Star Zeng <star.zeng@intel.com>, Jian J Wang <jian.j.wang@intel.com>
Subject: [Patch v1 1/1] MdeModulePkg: fix comments in BaseSortLib
Date: Wed, 31 Oct 2018 12:21:03 -0700	[thread overview]
Message-ID: <5bf5eb7f049f4046e8d11a512a2633f89b42a307.1541013629.git.jaben.carsey@intel.com> (raw)
In-Reply-To: <cover.1541013629.git.jaben.carsey@intel.com>

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



       reply	other threads:[~2018-10-31 19:21 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <cover.1541013629.git.jaben.carsey@intel.com>
2018-10-31 19:21 ` Jaben Carsey [this message]
2018-11-01  1:37   ` [Patch v1 1/1] MdeModulePkg: fix comments in BaseSortLib Zeng, Star
     [not found] <cover.1546984652.git.jaben.carsey@intel.com>
2019-01-08 21:58 ` Jaben Carsey
2019-01-09  0:50   ` Wang, Jian J
2019-01-09  1:18   ` Zeng, Star
2019-01-09 18:29     ` Carsey, Jaben

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=5bf5eb7f049f4046e8d11a512a2633f89b42a307.1541013629.git.jaben.carsey@intel.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox