From 05eee243c7e5fb8d501807a3b11065e1bf2c2b9a Mon Sep 17 00:00:00 2001
From: Magnus Henoch <magnus.henoch@erlang-solutions.com>
Date: Wed, 11 Nov 2015 15:33:39 +0000
Subject: Fix documentation of net_kernel:allow/1

Make the documentation reflect what the function actually does.
---
 lib/kernel/doc/src/net_kernel.xml | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

(limited to 'lib')

diff --git a/lib/kernel/doc/src/net_kernel.xml b/lib/kernel/doc/src/net_kernel.xml
index a0132db8db..311e0d8ea4 100644
--- a/lib/kernel/doc/src/net_kernel.xml
+++ b/lib/kernel/doc/src/net_kernel.xml
@@ -63,11 +63,16 @@
   <funcs>
     <func>
       <name name="allow" arity="1"/>
-      <fsummary>Limit access to a specified set of nodes</fsummary>
+      <fsummary>Permit access to a specified set of nodes</fsummary>
       <desc>
-        <p>Limits access to the specified set of nodes. Any access
-          attempts made from (or to) nodes not in <c><anno>Nodes</anno></c> will be
-          rejected.</p>
+        <p>Permits access to the specified set of nodes.</p>
+        <p>Before the first call to <c>allow/1</c>, any node with the correct
+          cookie can be connected. When <c>allow/1</c> is called, a list
+          of allowed nodes is established. Any access attempts made from (or to)
+          nodes not in that list will be rejected.</p>
+        <p>Subsequent calls to <c>allow/1</c> will add the specified nodes
+          to the list of allowed nodes. It is not possible to remove nodes
+          from the list.</p>
         <p>Returns <c>error</c> if any element in <c><anno>Nodes</anno></c> is not
           an atom.</p>
       </desc>
-- 
cgit v1.2.3