diff options
| author | Sverker Eriksson <[email protected]> | 2018-07-16 18:41:13 +0200 |
|---|---|---|
| committer | Sverker Eriksson <[email protected]> | 2018-07-16 18:41:13 +0200 |
| commit | 970732aaabaf7184dc11af27dc0211e9d93c05c6 (patch) | |
| tree | d8fd2bb5a7837e76bdcc332d41e9c080adb34b25 | |
| parent | 929d4f0b3cf5ee01164ebd7171b37fe2f05ce0d0 (diff) | |
| download | otp-970732aaabaf7184dc11af27dc0211e9d93c05c6.tar.gz otp-970732aaabaf7184dc11af27dc0211e9d93c05c6.tar.bz2 otp-970732aaabaf7184dc11af27dc0211e9d93c05c6.zip | |
erts: Clarify erl_nif docs of enif_*printf and %T
| -rw-r--r-- | erts/doc/src/erl_nif.xml | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/erts/doc/src/erl_nif.xml b/erts/doc/src/erl_nif.xml index 0fff8f7cad..a20b8ee884 100644 --- a/erts/doc/src/erl_nif.xml +++ b/erts/doc/src/erl_nif.xml @@ -1250,8 +1250,9 @@ typedef struct { <fsummary>Format strings and Erlang terms.</fsummary> <desc> <p>Similar to <c>fprintf</c> but this format string also accepts - <c>"%T"</c>, which formats Erlang terms.</p> - <p>This function was originally intenden for debugging purpose. It is not + <c>"%T"</c>, which formats Erlang terms of type + <seealso marker="#ERL_NIF_TERM"><c>ERL_NIF_TERM</c></seealso>.</p> + <p>This function is primarily intenden for debugging purpose. It is not recommended to print very large terms with <c>%T</c>. The function may change <c>errno</c>, even if successful.</p> </desc> @@ -3191,8 +3192,9 @@ if (retval & ERL_NIF_SELECT_STOP_CALLED) { <fsummary>Format strings and Erlang terms.</fsummary> <desc> <p>Similar to <c>snprintf</c> but this format string also accepts - <c>"%T"</c>, which formats Erlang terms.</p> - <p>This function was originally intenden for debugging purpose. It is not + <c>"%T"</c>, which formats Erlang terms of type + <seealso marker="#ERL_NIF_TERM"><c>ERL_NIF_TERM</c></seealso>.</p> + <p>This function is primarily intenden for debugging purpose. It is not recommended to print very large terms with <c>%T</c>. The function may change <c>errno</c>, even if successful.</p> </desc> |