Bug 1384233 - Update documentation for the %I format specifier in Printf.h. r?froydnj draft
authorKartikaya Gupta <kgupta@mozilla.com>
Wed, 26 Jul 2017 16:08:34 -0400
changeset 616169 5d0ed9ca9779a0ebbdeef7da1ea587695857b822
parent 616168 4649f6c50468706ef172ac17dd2dfe19e7ce9573
child 639410 d1cfe4dc9dff347f16ff07338412df89698c300a
push id70617
push userkgupta@mozilla.com
push dateWed, 26 Jul 2017 20:09:25 +0000
reviewersfroydnj
bugs1384233
milestone56.0a1
Bug 1384233 - Update documentation for the %I format specifier in Printf.h. r?froydnj MozReview-Commit-ID: 5bxCGKYrXFI
mozglue/misc/Printf.h
--- a/mozglue/misc/Printf.h
+++ b/mozglue/misc/Printf.h
@@ -32,18 +32,21 @@
 **      %u - unsigned decimal
 **      %x - unsigned hex
 **      %X - unsigned uppercase hex
 **      %o - unsigned octal
 **      %hd, %hu, %hx, %hX, %ho - "short" versions of above
 **      %ld, %lu, %lx, %lX, %lo - "long" versions of above
 **      %lld, %llu, %llx, %llX, %llo - "long long" versions of above
 **      %zd, %zo, %zu, %zx, %zX - size_t versions of above
-**      %Id, %Io, %Iu, %Ix, %IX - size_t versions of above (for Windows compat)
-**           You should use PRI*SIZE macros instead
+**      %Id, %Io, %Iu, %Ix, %IX - size_t versions of above (for Windows compat).
+**           Note that MSVC 2015 and newer supports the z length modifier so
+**           users should prefer using %z instead of %I. We are leaving in the
+**           %I support in case third-party code that uses it gets routed to
+**           use this printf implementation.
 **      %s - string
 **      %S, %ls - wide string, that is wchar_t*
 **      %c - character
 **      %p - pointer (deals with machine dependent pointer size)
 **      %f - float; note that this is actually formatted using the
 **           system's native printf, and so the results may vary
 **      %g - float; note that this is actually formatted using the
 **           system's native printf, and so the results may vary