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

[mirror_edk2.git] / IntelFrameworkModulePkg / Library / PeiDxeDebugLibReportStatusCode / DebugLib.c

diff --git a/IntelFrameworkModulePkg/Library/PeiDxeDebugLibReportStatusCode/DebugLib.c b/IntelFrameworkModulePkg/Library/PeiDxeDebugLibReportStatusCode/DebugLib.c
index 20f52f86bfbec31d7afb6c20da403dfdd0d2a10a..980255165dffcec0ec3d513564801e0fb654f1f0 100644 (file)
--- a/IntelFrameworkModulePkg/Library/PeiDxeDebugLibReportStatusCode/DebugLib.c
+++ b/IntelFrameworkModulePkg/Library/PeiDxeDebugLibReportStatusCode/DebugLib.c
@@ -1,6 +1,9 @@
 /** @file\r
   Debug Library based on report status code library.\r
 \r
+  Note that if the debug message length is larger than the maximum allowable\r
+  record length, then the debug message will be ignored directly.\r
+\r
   Copyright (c) 2006 - 2009, Intel Corporation<BR>\r
   All rights reserved. This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
@@ -32,6 +35,9 @@
 \r
   If Format is NULL, then ASSERT().\r
 \r
+  If the length of the message string specificed by Format is larger than the maximum allowable\r
+  record length, then directly return and not print it.\r
+\r
   @param  ErrorLevel  The error level of the debug message.\r
   @param  Format      Format string for the debug message to print.\r
   @param  ...         Variable argument list whose contents are accessed \r