update file/function comments to list the string length limitation.

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

2 files changed, 7 insertions, 1 deletions

diff --git a/IntelFrameworkModulePkg/Include/Guid/StatusCodeDataTypeDebug.h b/IntelFrameworkModulePkg/Include/Guid/StatusCodeDataTypeDebug.h
index e87947735f..52e7c95e73 100644
--- a/IntelFrameworkModulePkg/Include/Guid/StatusCodeDataTypeDebug.h
+++ b/IntelFrameworkModulePkg/Include/Guid/StatusCodeDataTypeDebug.h
@@ -25,7 +25,7 @@
   }

 

 ///

-/// The maximum size of an EFI_DEBUG_INO structure

+/// The maximum size of an EFI_DEBUG_INFO structure

 ///

 #define EFI_STATUS_CODE_DATA_MAX_SIZE 200

 

diff --git a/IntelFrameworkModulePkg/Library/PeiDxeDebugLibReportStatusCode/DebugLib.c b/IntelFrameworkModulePkg/Library/PeiDxeDebugLibReportStatusCode/DebugLib.c
index 20f52f86bf..980255165d 100644
--- a/IntelFrameworkModulePkg/Library/PeiDxeDebugLibReportStatusCode/DebugLib.c
+++ b/IntelFrameworkModulePkg/Library/PeiDxeDebugLibReportStatusCode/DebugLib.c
@@ -1,6 +1,9 @@
 /** @file

   Debug Library based on report status code library.

 

+  Note that if the debug message length is larger than the maximum allowable

+  record length, then the debug message will be ignored directly.

+

   Copyright (c) 2006 - 2009, Intel Corporation<BR>

   All rights reserved. This program and the accompanying materials

   are licensed and made available under the terms and conditions of the BSD License

@@ -32,6 +35,9 @@
 

   If Format is NULL, then ASSERT().

 

+  If the length of the message string specificed by Format is larger than the maximum allowable

+  record length, then directly return and not print it.

+

   @param  ErrorLevel  The error level of the debug message.

   @param  Format      Format string for the debug message to print.

   @param  ...         Variable argument list whose contents are accessed