Adjust the behavior of the MdePkg Print Library class to produce a consistent style...

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

diff --git a/MdePkg/Include/Library/PrintLib.h b/MdePkg/Include/Library/PrintLib.h
index 207d33c470506de1e49cd41baa0a7a92dadb616a..9aca725f7ffed5ccd06221a5356ab3e454d4c462 100644 (file)
--- a/MdePkg/Include/Library/PrintLib.h
+++ b/MdePkg/Include/Library/PrintLib.h
@@ -15,11 +15,18 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   strings.  Many of the output functions use a format string to describe how to \r
   format the output of variable arguments.  The format string consists of normal \r
   text and argument descriptors.  There are no restrictions for how the normal \r
-  text and argument descriptors can be mixed.  A normal text character '\n' must \r
-  always be converted to '\n\r'.  This does not follow the ANSI C standard for \r
-  sprint().  The format of argument descriptors is described below.  The ANSI C \r
-  standard for sprint() has been followed for some of the format types, and has \r
-  not been followed for others.  The exceptions are noted below.\r
+  text and argument descriptors can be mixed.  The following end of line(EOL) \r
+  translations must be performed on the contents of the format string:\r
+  \r
+     - '\\r' is translated to '\\r'\r
+     - '\\r\\n' is translated to '\\r\\n'\r
+     - '\\n' is translated to '\\r\\n' \r
+     - '\\n\\r' is translated to '\\r\\n'\r
+  \r
+  This does not follow the ANSI C standard for sprint().  The format of argument \r
+  descriptors is described below.  The ANSI C standard for sprint() has been \r
+  followed for some of the format types, and has not been followed for others.  \r
+  The exceptions are noted below.\r
 \r
     %[flags][width][.precision]type\r
 \r