From 970732aaabaf7184dc11af27dc0211e9d93c05c6 Mon Sep 17 00:00:00 2001 From: Sverker Eriksson Date: Mon, 16 Jul 2018 18:41:13 +0200 Subject: erts: Clarify erl_nif docs of enif_*printf and %T --- erts/doc/src/erl_nif.xml | 10 ++++++---- 1 file 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 { Format strings and Erlang terms.

Similar to fprintf but this format string also accepts - "%T", which formats Erlang terms.

-

This function was originally intenden for debugging purpose. It is not + "%T", which formats Erlang terms of type + ERL_NIF_TERM.

+

This function is primarily intenden for debugging purpose. It is not recommended to print very large terms with %T. The function may change errno, even if successful.

@@ -3191,8 +3192,9 @@ if (retval & ERL_NIF_SELECT_STOP_CALLED) { Format strings and Erlang terms.

Similar to snprintf but this format string also accepts - "%T", which formats Erlang terms.

-

This function was originally intenden for debugging purpose. It is not + "%T", which formats Erlang terms of type + ERL_NIF_TERM.

+

This function is primarily intenden for debugging purpose. It is not recommended to print very large terms with %T. The function may change errno, even if successful.

-- cgit v1.2.3 From 2072896468a6de9d94f757fc293fb68b06725e32 Mon Sep 17 00:00:00 2001 From: Sverker Eriksson Date: Mon, 16 Jul 2018 19:21:10 +0200 Subject: Add some more to the pull request instructions Branch names and whitespaces. --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) 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: -- cgit v1.2.3