Add check for Zero Relocation section.

[mirror_edk2.git] / MdePkg / Include / Library / PeCoffLib.h

diff --git a/MdePkg/Include/Library/PeCoffLib.h b/MdePkg/Include/Library/PeCoffLib.h
index d2f9d5ea5e94246c88fcdfaa141842c0c0f89138..c02e75169e8ecfbcf16af5a70e54b315462fbcea 100644 (file)
--- a/MdePkg/Include/Library/PeCoffLib.h
+++ b/MdePkg/Include/Library/PeCoffLib.h
@@ -319,9 +319,11 @@ PeCoffLoaderImageReadFromMemory (
   Reapply fixups on a fixed up PE32/PE32+ image to allow virutal calling at EFI\r
   runtime. \r
   \r
-  PE_COFF_LOADER_IMAGE_CONTEXT.FixupData stores information needed to reapply\r
-  the fixups with a virtual mapping.\r
-\r
+  This function reapplies relocation fixups to the PE/COFF image specified by ImageBase \r
+  and ImageSize so the image will execute correctly when the PE/COFF image is mapped \r
+  to the address specified by VirtualImageBase.  RelocationData must be identical \r
+  to the FiuxupData buffer from the PE_COFF_LOADER_IMAGE_CONTEXT structure \r
+  after this PE/COFF image was relocated with PeCoffLoaderRelocateImage().\r
 \r
   @param  ImageBase          Base address of a PE/COFF image that has been loaded \r
                              and relocated into system memory.\r