File 0102-erts-Add-enif_fprintf-docs.patch of Package erlang
From 07444cf881f6e8bca808a04a7eddd2ed1ac74ce6 Mon Sep 17 00:00:00 2001
From: Sverker Eriksson <sverker@erlang.org>
Date: Wed, 7 Mar 2018 19:14:25 +0100
Subject: [PATCH 2/2] erts: Add enif_fprintf docs
---
erts/doc/src/erl_nif.xml | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/erts/doc/src/erl_nif.xml b/erts/doc/src/erl_nif.xml
index f2f380ca4e..9b446615a4 100644
--- a/erts/doc/src/erl_nif.xml
+++ b/erts/doc/src/erl_nif.xml
@@ -1235,6 +1235,17 @@ typedef struct {
</desc>
</func>
+ <func>
+ <name><ret>int</ret><nametext>enif_fprintf(FILE *stream, const char *format, ...)</nametext></name>
+ <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
+ recommended to print very large terms with <c>%T</c>.</p>
+ </desc>
+ </func>
+
<func>
<name><ret>void</ret><nametext>enif_free(void* ptr)</nametext></name>
<fsummary>Free dynamic memory.</fsummary>
@@ -3136,6 +3147,8 @@ if (retval & ERL_NIF_SELECT_STOP_CALLED) {
<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
+ recommended to print very large terms with <c>%T</c>.</p>
</desc>
</func>
--
2.16.2