From: ydong10 <ydong10@6f19259b-4bc3-4df7-8a09-765794883524>
Date: Tue, 11 Sep 2012 10:26:44 +0000 (+0000)
Subject: Enhance the comments.
X-Git-Tag: edk2-stable201903~13065
X-Git-Url: https://git.proxmox.com/?a=commitdiff_plain;h=158e788f78c720ccbe9b98d68b787dfe0b588a85;hp=2aadc9205b8c1ea8b002e2bc05dcaed7b1505121;p=mirror_edk2.git

Enhance the comments.

Signed-off-by: Dong Eric <eric.dong@intel.com>
Reviewed-by: Ye Ting  <ting.ye@intel.com>

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@13715 6f19259b-4bc3-4df7-8a09-765794883524
---

diff --git a/MdePkg/Library/BasePeCoffLib/BasePeCoff.c b/MdePkg/Library/BasePeCoffLib/BasePeCoff.c
index a51320b037..e1b4cb6567 100644
--- a/MdePkg/Library/BasePeCoffLib/BasePeCoff.c
+++ b/MdePkg/Library/BasePeCoffLib/BasePeCoff.c
@@ -1718,6 +1718,8 @@ PeCoffLoaderRelocateImageForRuntime (
   PE/COFF image starting at byte offset FileOffset into the buffer specified by Buffer.  
   The size of the buffer actually read is returned in ReadSize.
   
+  The caller must make sure the FileOffset and ReadSize within the file scope.
+
   If FileHandle is NULL, then ASSERT().
   If ReadSize is NULL, then ASSERT().
   If Buffer is NULL, then ASSERT().