MdeModulePkg PeiCore: Improve comment semantics

This patch clarifies wording in several PeiCore comments to improve
reading comprehension.

Cc: Dandan Bi <dandan.bi@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Hao A Wu <hao.a.wu@intel.com>
Signed-off-by: Michael Kubacki <michael.a.kubacki@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
Reviewed-by: Jian J Wang <jian.j.wang@intel.com>

diff --git a/MdeModulePkg/Core/Pei/Dependency/Dependency.c b/MdeModulePkg/Core/Pei/Dependency/Dependency.c
index 9a8353aef206788d9ec3e4139f695205c320d4a3..b53e5f2686ef945318002d63cbf09f0e0426601c 100644 (file)
--- a/MdeModulePkg/Core/Pei/Dependency/Dependency.c
+++ b/MdeModulePkg/Core/Pei/Dependency/Dependency.c
@@ -2,8 +2,8 @@
   PEI Dispatcher Dependency Evaluator\r
 \r
   This routine evaluates a dependency expression (DEPENDENCY_EXPRESSION) to determine\r
-  if a driver can be scheduled for execution.  The criteria for\r
-  schedulability is that the dependency expression is satisfied.\r
+  if a driver can be scheduled for execution.  The criteria to be scheduled is\r
+  that the dependency expression is satisfied.\r
 \r
 Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>\r
 SPDX-License-Identifier: BSD-2-Clause-Patent\r

diff --git a/MdeModulePkg/Core/Pei/Dispatcher/Dispatcher.c b/MdeModulePkg/Core/Pei/Dispatcher/Dispatcher.c
index c9f2a912643f3bb8c78f1b4e6de5de8a2e462c4a..a18ac47f617a80ab3c46bb97e9907a8a58b5735f 100644 (file)
--- a/MdeModulePkg/Core/Pei/Dispatcher/Dispatcher.c
+++ b/MdeModulePkg/Core/Pei/Dispatcher/Dispatcher.c
@@ -1347,8 +1347,8 @@ DepexSatisfied (
 }\r
 \r
 /**\r
-  This routine enable a PEIM to register itself to shadow when PEI Foundation\r
-  discovery permanent memory.\r
+  This routine enables a PEIM to register itself for shadow when the PEI Foundation\r
+  discovers permanent memory.\r
 \r
   @param FileHandle             File handle of a PEIM.\r
 \r

diff --git a/MdeModulePkg/Core/Pei/FwVol/FwVol.c b/MdeModulePkg/Core/Pei/FwVol/FwVol.c
index c21eb9c039613a90d3ce6ae4f12a8b8b50171502..b3661146f29c8acb1a4e47f1b6471ef60bfe612d 100644 (file)
--- a/MdeModulePkg/Core/Pei/FwVol/FwVol.c
+++ b/MdeModulePkg/Core/Pei/FwVol/FwVol.c
@@ -593,7 +593,7 @@ FirmwareVolumeInfoPpiNotifyCallback (
   }\r
 \r
   //\r
-  // Locate the corresponding FV_PPI according to founded FV's format GUID\r
+  // Locate the corresponding FV_PPI according to the format GUID of the FV found\r
   //\r
   Status = PeiServicesLocatePpi (\r
              &FvInfo2Ppi.FvFormat,\r
@@ -1533,7 +1533,7 @@ ProcessFvFile (
       );\r
 \r
     //\r
-    // Inform the extracted FvImage to FV HOB consumer phase, i.e. DXE phase\r
+    // Expose the extracted FvImage to the FV HOB consumer phase, i.e. DXE phase\r
     //\r
     BuildFvHob (\r
       (EFI_PHYSICAL_ADDRESS) (UINTN) FvHeader,\r
@@ -2087,12 +2087,13 @@ FvHandleToCoreHandle (
 }\r
 \r
 /**\r
-  Get instance of PEI_CORE_FV_HANDLE for next volume according to given index.\r
+  Gets a PEI_CORE_FV_HANDLE instance for the next volume according to the given index.\r
 \r
-  This routine also will install FvInfo PPI for FV HOB in PI ways.\r
+  This routine also will install an instance of the FvInfo PPI for the FV HOB\r
+  as defined in the PI specification.\r
 \r
   @param Private    Pointer of PEI_CORE_INSTANCE\r
-  @param Instance   The index of FV want to be searched.\r
+  @param Instance   Index of the FV to search\r
 \r
   @return Instance of PEI_CORE_FV_HANDLE.\r
 **/\r
@@ -2185,13 +2186,14 @@ PeiReinitializeFv (
 }\r
 \r
 /**\r
-  Report the information for a new discovered FV in unknown third-party format.\r
+  Report the information for a newly discovered FV in an unknown format.\r
 \r
-  If the EFI_PEI_FIRMWARE_VOLUME_PPI has not been installed for third-party FV format, but\r
-  the FV in this format has been discovered, then this FV's information will be cached into\r
-  PEI_CORE_INSTANCE's UnknownFvInfo array.\r
-  Also a notification would be installed for unknown third-party FV format guid, if EFI_PEI_FIRMWARE_VOLUME_PPI\r
-  is installed later by platform's PEIM, the original unknown third-party FV will be processed by\r
+  If the EFI_PEI_FIRMWARE_VOLUME_PPI has not been installed for a third-party FV format, but\r
+  the FV has been discovered, then the information of this FV will be cached into PEI_CORE_INSTANCE's\r
+  UnknownFvInfo array.\r
+\r
+  Also a notification would be installed for unknown FV format GUID, if EFI_PEI_FIRMWARE_VOLUME_PPI\r
+  is installed later by platform's PEIM, the original unknown FV will be processed by\r
   using new installed EFI_PEI_FIRMWARE_VOLUME_PPI.\r
 \r
   @param PrivateData  Point to instance of PEI_CORE_INSTANCE\r

diff --git a/MdeModulePkg/Core/Pei/FwVol/FwVol.h b/MdeModulePkg/Core/Pei/FwVol/FwVol.h
index 263f0d7a560c858b51ff70abe41f70d5d4817bbf..7241c01b8cb347c297f4b72362380cc19eb7a4e7 100644 (file)
--- a/MdeModulePkg/Core/Pei/FwVol/FwVol.h
+++ b/MdeModulePkg/Core/Pei/FwVol/FwVol.h
@@ -303,11 +303,12 @@ FindFileEx (
   );\r
 \r
 /**\r
-  Report the information for a new discovered FV in unknown format.\r
+  Report the information for a newly discovered FV in an unknown format.\r
+\r
+  If the EFI_PEI_FIRMWARE_VOLUME_PPI has not been installed for a third-party FV format, but\r
+  the FV has been discovered, then the information of this FV will be cached into PEI_CORE_INSTANCE's\r
+  UnknownFvInfo array.\r
 \r
-  If the EFI_PEI_FIRMWARE_VOLUME_PPI has not been installed for specific FV format, but\r
-  the FV in this FV format has been discovered, then the information of this FV\r
-  will be cached into PEI_CORE_INSTANCE's UnknownFvInfo array.\r
   Also a notification would be installed for unknown FV format GUID, if EFI_PEI_FIRMWARE_VOLUME_PPI\r
   is installed later by platform's PEIM, the original unknown FV will be processed by\r
   using new installed EFI_PEI_FIRMWARE_VOLUME_PPI.\r

diff --git a/MdeModulePkg/Core/Pei/Memory/MemoryServices.c b/MdeModulePkg/Core/Pei/Memory/MemoryServices.c
index 838a003baaf238719c2dfe715fe09087aec3e4f6..6b3a64a811cd3cff475fd708420d721a88995b8c 100644 (file)
--- a/MdeModulePkg/Core/Pei/Memory/MemoryServices.c
+++ b/MdeModulePkg/Core/Pei/Memory/MemoryServices.c
@@ -759,8 +759,8 @@ PeiFreePages (
 /**\r
 \r
   Pool allocation service. Before permanent memory is discovered, the pool will\r
-  be allocated the heap in the temporary memory. Generally, the size of heap in temporary\r
-  memory does not exceed to 64K, so the biggest pool size could be allocated is\r
+  be allocated in the heap in temporary memory. Generally, the size of the heap in temporary\r
+  memory does not exceed 64K, so the biggest pool size could be allocated is\r
   64K.\r
 \r
   @param PeiServices               An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
@@ -789,7 +789,7 @@ PeiAllocatePool (
   //\r
 \r
   //\r
-  // Generally, the size of heap in temporary memory does not exceed to 64K,\r
+  // Generally, the size of heap in temporary memory does not exceed 64K,\r
   // HobLength is multiples of 8 bytes, so the maximum size of pool is 0xFFF8 - sizeof (EFI_HOB_MEMORY_POOL)\r
   //\r
   if (Size > (0xFFF8 - sizeof (EFI_HOB_MEMORY_POOL))) {\r

diff --git a/MdeModulePkg/Core/Pei/PeiMain.h b/MdeModulePkg/Core/Pei/PeiMain.h
index 3f61247a0f71d60670ae74488183944ecabfba4d..6431bdaaacf6246c56f1e16b8c781dd213fb5d62 100644 (file)
--- a/MdeModulePkg/Core/Pei/PeiMain.h
+++ b/MdeModulePkg/Core/Pei/PeiMain.h
@@ -1217,8 +1217,8 @@ PeiFfsGetVolumeInfo (
   );\r
 \r
 /**\r
-  This routine enable a PEIM to register itself to shadow when PEI Foundation\r
-  discovery permanent memory.\r
+  This routine enables a PEIM to register itself for shadow when the PEI Foundation\r
+  discovers permanent memory.\r
 \r
   @param FileHandle             File handle of a PEIM.\r
 \r
@@ -1314,12 +1314,13 @@ ProcessFvFile (
   );\r
 \r
 /**\r
-  Get instance of PEI_CORE_FV_HANDLE for next volume according to given index.\r
+  Gets a PEI_CORE_FV_HANDLE instance for the next volume according to the given index.\r
 \r
-  This routine also will install FvInfo PPI for FV HOB in PI ways.\r
+  This routine also will install an instance of the FvInfo PPI for the FV HOB\r
+  as defined in the PI specification.\r
 \r
   @param Private    Pointer of PEI_CORE_INSTANCE\r
-  @param Instance   The index of FV want to be searched.\r
+  @param Instance   Index of the FV to search\r
 \r
   @return Instance of PEI_CORE_FV_HANDLE.\r
 **/\r