From 72a11f23ebbbc204213c8b339e32ed6082d5ea50 Mon Sep 17 00:00:00 2001
From: Patrik Nyblom <pan@erlang.org>
Date: Tue, 31 Aug 2010 15:13:29 +0200
Subject: Update erl_interface doc and testsuite for epmd changes

---
 lib/erl_interface/doc/src/ei_connect.xml  | 27 +++++++++++++++------------
 lib/erl_interface/doc/src/erl_connect.xml | 29 ++++++++++++++++-------------
 2 files changed, 31 insertions(+), 25 deletions(-)

(limited to 'lib/erl_interface/doc/src')

diff --git a/lib/erl_interface/doc/src/ei_connect.xml b/lib/erl_interface/doc/src/ei_connect.xml
index 927395d1bf..16439510cc 100644
--- a/lib/erl_interface/doc/src/ei_connect.xml
+++ b/lib/erl_interface/doc/src/ei_connect.xml
@@ -4,7 +4,7 @@
 <cref>
   <header>
     <copyright>
-      <year>2001</year><year>2009</year>
+      <year>2001</year><year>2010</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -508,7 +508,7 @@ if (ei_decode_version(result.buff, &index) < 0
           same as the port number that was previously bound to the socket.</p>
         <p><c><![CDATA[addr]]></c> is the 32-bit IP address of the local host.</p>
         <p>To unregister with epmd, simply close the returned
-          descriptor. See also <c><![CDATA[ei_unpublish()]]></c>.</p>
+          descriptor. Do not use <c><![CDATA[ei_unpublish()]]></c>, which is deprecated anyway.</p>
         <p>On success, the functions return a descriptor connecting the
           calling process to epmd. On failure, they return -1 and set
           <c><![CDATA[erl_errno]]></c> to <c><![CDATA[EIO]]></c>.</p>
@@ -558,18 +558,21 @@ typedef struct {
     </func>
     <func>
       <name><ret>int</ret><nametext>ei_unpublish(ei_cnode *ec)</nametext></name>
-      <fsummary>Unpublish a node name</fsummary>
+      <fsummary>Forcefully unpublish a node name</fsummary>
       <desc>
         <p>This function can be called by a process to unregister a
-          specified node from epmd on the localhost. This may be
-          useful, for example, when epmd has not detected the failure of a
-          node, and will not allow the name to be reused. If you use this
-          function to unregister your own process, be sure to also close
-          the descriptor that was returned by <c><![CDATA[ei_publish()]]></c>.</p>
-        <note>
-          <p>Careless use of this function may have unpredictable
-            results, if the registered node is in fact still running.</p>
-        </note>
+          specified node from epmd on the localhost. This is however usually not 
+	  allowed, unless epmd was started with the -relaxed_command_check 
+	  flag, which it normally isn't.</p>
+
+	  <p>To unregister a node you have published, you should
+	  close the descriptor that was returned by  
+	  <c><![CDATA[ei_publish()]]></c>.</p> 
+
+        <warning>
+          <p>This function is deprecated and will be removed in a future 
+	  release.</p>
+        </warning>
         <p><c><![CDATA[ec]]></c> is the node structure of the node to unregister.</p>
         <p>If the node was successfully unregistered from epmd, the
           function returns 0. Otherwise, it returns -1 and sets
diff --git a/lib/erl_interface/doc/src/erl_connect.xml b/lib/erl_interface/doc/src/erl_connect.xml
index b2235925b2..bd5e637244 100644
--- a/lib/erl_interface/doc/src/erl_connect.xml
+++ b/lib/erl_interface/doc/src/erl_connect.xml
@@ -4,7 +4,7 @@
 <cref>
   <header>
     <copyright>
-      <year>1996</year><year>2009</year>
+      <year>1996</year><year>2010</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -451,7 +451,7 @@ typedef struct {
         <p><c><![CDATA[port]]></c> is the local name to register, and should be the
           same as the port number that was previously bound to the socket.</p>
         <p>To unregister with epmd, simply close the returned
-          descriptor. See also <c><![CDATA[erl_unpublish()]]></c>.
+          descriptor.
           </p>
         <p>On success, the functions return a descriptor connecting the
           calling process to epmd. On failure, they return -1 and set
@@ -507,21 +507,24 @@ typedef struct {
     </func>
     <func>
       <name><ret>int</ret><nametext>erl_unpublish(alive)</nametext></name>
-      <fsummary>Unpublish a node name</fsummary>
+      <fsummary>Forcefully unpublish a node name</fsummary>
       <type>
         <v>char *alive;</v>
       </type>
       <desc>
-        <p>This function can be called by a process to unregister a
-          specified node name from epmd on the localhost. This may be
-          useful, for example, when epmd has not detected the failure of a
-          node, and will not allow the name to be reused. If you use this
-          function to unregister your own process, be sure to also close
-          the descriptor that was returned by <c><![CDATA[erl_publish()]]></c>.</p>
-        <note>
-          <p>Careless use of this function may have unpredictable
-            results, if the registered node is in fact still running.</p>
-        </note>
+       <p>This function can be called by a process to unregister a
+          specified node from epmd on the localhost. This is however usually not 
+	  allowed, unless epmd was started with the -relaxed_command_check 
+	  flag, which it normally isn't.</p>
+
+	  <p>To unregister a node you have published, you should instead
+	  close the descriptor that was returned by  
+	  <c><![CDATA[ei_publish()]]></c>.</p> 
+
+        <warning>
+          <p>This function is deprecated and will be removed in a future 
+	  release.</p>
+        </warning>
         <p><c><![CDATA[alive]]></c> is the name of the node to unregister, i.e., the
           first component of the nodename, without the <c><![CDATA[@hostname]]></c>.</p>
         <p>If the node was successfully unregistered from epmd, the
-- 
cgit v1.2.3