diff options
| author | Sverker Eriksson <[email protected]> | 2018-07-16 19:27:29 +0200 |
|---|---|---|
| committer | Sverker Eriksson <[email protected]> | 2018-07-16 19:27:29 +0200 |
| commit | d557a4090f593faff4ef4f990a1ca73bfebaab83 (patch) | |
| tree | b913719f21f35321eb0e873718cd1210095d7e61 | |
| parent | ca8242fb75dbf1a3035fe5acdeb226d3b948d4b9 (diff) | |
| parent | 2072896468a6de9d94f757fc293fb68b06725e32 (diff) | |
| download | otp-d557a4090f593faff4ef4f990a1ca73bfebaab83.tar.gz otp-d557a4090f593faff4ef4f990a1ca73bfebaab83.tar.bz2 otp-d557a4090f593faff4ef4f990a1ca73bfebaab83.zip | |
Merge branch 'sverker/enif_printf-docs' into maint
| -rw-r--r-- | CONTRIBUTING.md | 2 | ||||
| -rw-r--r-- | erts/doc/src/erl_nif.xml | 10 |
2 files changed, 8 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c89301d0eb..96db464b52 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,6 +43,7 @@ for more information. You can contribute to Erlang/OTP by opening a Pull Request. Make sure you create a new branch for your pull request with `git checkout -b new-branch-name`. +Give the branch a short but descriptive name, like `stdlib/lists-length-fix`. Never do your work directly on `maint` or `master`. ## Fixing a bug @@ -108,6 +109,7 @@ conflicts or include the latest changes. compiled and that it works. * Check for unnecessary whitespace before committing with `git diff --check`. +However, do not fix preexisting whitespace errors in otherwise untouched source lines. Check your coding style: 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> |