File 0321-erlang-module-doc-preciser-description-of-... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 0321-erlang-module-doc-preciser-description-of-erlang-is_.patch of Package erlang (Revision 6cc4e2769dd7ada0d41c527b51da0114)

Currently displaying revision 6cc4e2769dd7ada0d41c527b51da0114 , Show latest

From 39bfe37418ebae1cbb663dc3c0155f3f1e286bb3 Mon Sep 17 00:00:00 2001
From: Kjell Winblad <kjellwinblad@gmail.com>
Date: Thu, 17 Sep 2020 14:59:32 +0200
Subject: [PATCH 21/39] erlang module doc: preciser description of
 erlang:is_alive()

---
 erts/doc/src/erl_cmd.xml |  2 +-
 erts/doc/src/erlang.xml  | 13 +++++++++++--
 2 files changed, 12 insertions(+), 3 deletions(-)

diff --git a/erts/doc/src/erl_cmd.xml b/erts/doc/src/erl_cmd.xml
index 1c9b3e2294..614a3262db 100644
--- a/erts/doc/src/erl_cmd.xml
+++ b/erts/doc/src/erl_cmd.xml
@@ -555,7 +555,7 @@
 <c><![CDATA[Time]]></c> milliseconds have elapsed, all processes still
 existing are killed. Defaults to <c><![CDATA[infinity]]></c>.
 </item>
- <tag><c><![CDATA[-sname Name]]></c></tag>
+ <tag><marker id="sname"/><c><![CDATA[-sname Name]]></c></tag>
 <item>
 Makes the Erlang runtime system into a distributed node, similar to
 <seecom marker="#name"><c><![CDATA[-name]]></c></seecom>, but the host
diff --git a/erts/doc/src/erlang.xml b/erts/doc/src/erlang.xml
index 2e8c9f5247..0d4c46bd9c 100644
--- a/erts/doc/src/erlang.xml
+++ b/erts/doc/src/erlang.xml
@@ -2546,8 +2546,17 @@ os_prompt%</pre>
 <fsummary>Check whether the local node is alive.</fsummary>
 <desc>
 Returns <c>true</c> if the local node is alive (that is, if
- the node can be part of a distributed system), otherwise
- <c>false</c>.
+ the node can be part of a distributed system), otherwise
+ <c>false</c>. A node is alive if it is started with:
+ <list type="ordered">
+ <item><seecom marker="erl#name"><c>"erl -name LONGNAME"</c></seecom> or,</item>
+ <item><seecom marker="erl#sname"><c>"erl -sname SHORTNAME"</c></seecom>.</item>
+ </list>
+ A node
+ can also be alive if it has got a name from a call to <seemfa
+ marker="kernel:net_kernel#start/1"><c>net_kernel:start/1</c></seemfa>
+ and has not been stopped by a call to <seemfa
+ marker="kernel:net_kernel#stop/0"><c>net_kernel:stop/0</c></seemfa>.
 </desc>
 </func>
 
-- 
2.26.2

Places

File 0321-erlang-module-doc-preciser-description-of-erlang-is_.patch of Package erlang (Revision 6cc4e2769dd7ada0d41c527b51da0114)

Places