diff options
author | Zandra <[email protected]> | 2016-02-04 15:28:24 +0100 |
---|---|---|
committer | Zandra <[email protected]> | 2016-02-04 15:28:24 +0100 |
commit | 66fc5eda45507c637571b2baa97e0fa4aab8033f (patch) | |
tree | 6dd9d18a6d3abd0a74ed5dbb7710ed00b7f705bb /lib/kernel/doc | |
parent | e3d8f19dc43a54dcae9acc7a3803e41387fccc4d (diff) | |
parent | 05eee243c7e5fb8d501807a3b11065e1bf2c2b9a (diff) | |
download | otp-66fc5eda45507c637571b2baa97e0fa4aab8033f.tar.gz otp-66fc5eda45507c637571b2baa97e0fa4aab8033f.tar.bz2 otp-66fc5eda45507c637571b2baa97e0fa4aab8033f.zip |
Merge branch 'legoscia/patch-3' into maint
* legoscia/patch-3:
Fix documentation of net_kernel:allow/1
OTP-13299
Diffstat (limited to 'lib/kernel/doc')
-rw-r--r-- | lib/kernel/doc/src/net_kernel.xml | 13 |
1 files changed, 9 insertions, 4 deletions
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> |