Clarify BuildCvHob() API in HobLib to state that this function will ASSERT() if the...

[mirror_edk2.git] / IntelFrameworkPkg / Library / PeiHobLibFramework / HobLib.c

diff --git a/IntelFrameworkPkg/Library/PeiHobLibFramework/HobLib.c b/IntelFrameworkPkg/Library/PeiHobLibFramework/HobLib.c
index 1e8b85cb2e0dcfd59aed232efd09dbb1f4a4cf45..183ed99542566f56b4e04a7317ef0d7a74739732 100644 (file)
--- a/IntelFrameworkPkg/Library/PeiHobLibFramework/HobLib.c
+++ b/IntelFrameworkPkg/Library/PeiHobLibFramework/HobLib.c
@@ -480,6 +480,7 @@ BuildFv2Hob (
   It can only be invoked during PEI phase;\r
   for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.\r
   \r
+  If the platform does not support Capsule Volume HOBs, then ASSERT().\r
   If there is no additional space for HOB creation, then ASSERT().\r
 \r
   @param  BaseAddress   The base address of the Capsule Volume.\r