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

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

diff --git a/MdePkg/Include/Library/HobLib.h b/MdePkg/Include/Library/HobLib.h
index 08cb63e936a541381aa7044582d4b16c2a4f82c7..15905244938da7b08e629423c5444b525930392b 100644 (file)
--- a/MdePkg/Include/Library/HobLib.h
+++ b/MdePkg/Include/Library/HobLib.h
@@ -317,6 +317,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