Merge tag 'OTP-19.0' into sverker/19/binary_to_atom-utf8-crash/ERL-474/OTP-14590

1 files changed, 25 insertions, 14 deletions

diff --git a/erts/doc/src/driver_entry.xml b/erts/doc/src/driver_entry.xml
index c37138e7b1..ae7f264d0c 100644
--- a/erts/doc/src/driver_entry.xml
+++ b/erts/doc/src/driver_entry.xml
@@ -1,23 +1,24 @@
-<?xml version="1.0" encoding="latin1" ?>
+<?xml version="1.0" encoding="utf-8" ?>
 <!DOCTYPE cref SYSTEM "cref.dtd">
 
 <cref>
   <header>
     <copyright>
-      <year>2001</year><year>2012</year>
+      <year>2001</year><year>2015</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
-      The contents of this file are subject to the Erlang Public License,
-      Version 1.1, (the "License"); you may not use this file except in
-      compliance with the License. You should have received a copy of the
-      Erlang Public License along with this software. If not, it can be
-      retrieved online at http://www.erlang.org/.
+      Licensed under the Apache License, Version 2.0 (the "License");
+      you may not use this file except in compliance with the License.
+      You may obtain a copy of the License at
+ 
+          http://www.apache.org/licenses/LICENSE-2.0
 
-      Software distributed under the License is distributed on an "AS IS"
-      basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
-      the License for the specific language governing rights and limitations
-      under the License.
+      Unless required by applicable law or agreed to in writing, software
+      distributed under the License is distributed on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+      See the License for the specific language governing permissions and
+      limitations under the License.
 
     </legalnotice>
 
@@ -110,6 +111,8 @@
     <p>When the driver has passed the <c>driver_entry</c> over to
       the emulator, the driver is <em>not</em> allowed to modify the
       <c>driver_entry</c>.</p>
+    <p>If compiling a driver for static inclusion via --enable-static-drivers you
+    have to define STATIC_ERLANG_DRIVER before the DRIVER_INIT declaration.</p>
     <note>
       <p>Do <em>not</em> declare the <c>driver_entry</c> <c>const</c>. This since the emulator needs to
         modify the <c>handle</c>, and the <c>handle2</c>
@@ -123,7 +126,7 @@
   <section>
     <title>DATA TYPES</title>
     <taglist>
-    <tag><b>ErlDrvEntry</b></tag>
+    <tag><em>ErlDrvEntry</em></tag>
     <item>
     <p/>
     <code type="none">
@@ -208,7 +211,7 @@ typedef struct erl_drv_entry {
           number &gt;= 0 or a pointer, or if the driver can't be started,
           one of three error codes should be returned:</p>
         <p>ERL_DRV_ERROR_GENERAL - general error, no error code</p>
-        <p>ERL_DRV_ERROR_ERRNO - error with error code in erl_errno</p>
+        <p>ERL_DRV_ERROR_ERRNO - error with error code in <c>errno</c></p>
         <p>ERL_DRV_ERROR_BADARG - error, badarg</p>
         <p>If an error code is returned, the port isn't started.</p>
       </item>
@@ -232,6 +235,7 @@ typedef struct erl_drv_entry {
       </item>
 
       <tag><marker id="ready_input"/>void (*ready_input)(ErlDrvData drv_data, ErlDrvEvent event)</tag>
+      <item/>
       <tag><marker id="ready_output"/>void (*ready_output)(ErlDrvData drv_data, ErlDrvEvent event)</tag>
       <item>
         <p>This is called when a driver event (given in the
@@ -433,7 +437,14 @@ typedef struct erl_drv_entry {
 	  <seealso marker="erl_driver#erl_drv_busy_msgq_limits">erl_drv_busy_msgq_limits()</seealso>
 	  function.
           </item>
-        </taglist> 
+          <tag><c>ERL_DRV_FLAG_USE_INIT_ACK</c></tag>
+          <item>When this flag is given the linked-in driver has to manually
+          acknowledge that the port has been successfully started using 
+	  <seealso marker="erl_driver#erl_drv_init_ack">erl_drv_init_ack()</seealso>.
+          This allows the implementor to make the erlang:open_port exit with
+          badarg after some initial asynchronous initialization has been done.
+          </item>
+        </taglist>
       </item>
       <tag>void *handle2</tag>
       <item>