Merge branch 'bmk/erts/esock/20190614/split_modules/OTP-15765' into maint

5 files changed, 40 insertions, 141 deletions

diff --git a/erts/doc/src/Makefile b/erts/doc/src/Makefile
index bc01919da1..bb96293947 100644
--- a/erts/doc/src/Makefile
+++ b/erts/doc/src/Makefile
@@ -1,7 +1,7 @@
 #
 # %CopyrightBegin%
 #
-# Copyright Ericsson AB 1997-2018. All Rights Reserved.
+# Copyright Ericsson AB 1997-2019. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -47,6 +47,20 @@ XML_REF1_FILES = epmd.xml \
 	run_erl.xml \
 	start.xml
 
+ifeq ($(USE_ESOCK), yes)
+XML_REF3_ESOCK_EFILES = socket.xml
+XML_CHAPTER_ESOCK_EFILES = socket_usage.xml
+ESOCK_USE_SOCKET_XML=<xi:include href="socket.xml"\/>
+ESOCK_USE_SOCKET_SPECS_XML=<xi:include href="../specs/specs_socket.xml"/>
+ESOCK_USE_SOCKET_USAGE_XML=<xi:include href="socket_usage.xml"/>
+else
+XML_REF3_ESOCK_EFILES =
+XML_CHAPTER_ESOCK_EFILES =
+ESOCK_USE_SOCKET_XML =
+ESOCK_USE_SOCKET_SPECS_XML =
+ESOCK_USE_SOCKET_USAGE_XML =
+endif
+
 XML_REF3_EFILES = \
 	erl_prim_loader.xml \
 	erlang.xml \
@@ -56,8 +70,7 @@ XML_REF3_EFILES = \
 	atomics.xml \
 	counters.xml \
 	zlib.xml \
-	socket.xml \
-	net.xml
+	$(XML_REF3_ESOCK_EFILES)
 
 XML_REF3_FILES = \
 	$(XML_REF3_EFILES) \
@@ -94,7 +107,7 @@ XML_CHAPTER_FILES = \
 	driver.xml \
 	absform.xml \
 	inet_cfg.xml \
-	socket_usage.xml \
+	$(XML_CHAPTER_ESOCK_EFILES) \
 	erl_ext_dist.xml \
 	erl_dist_protocol.xml \
 	communication.xml \
@@ -159,7 +172,7 @@ $(HTMLDIR)/%.gif: %.gif
 $(XML_FIGURE_DIR)/%.png: ../../emulator/internal_doc/figures/%.png
 	$(INSTALL_DATA) $< $@
 
-docs: figures man pdf html $(INFO_FILE)
+docs: part ref_man specs figures man pdf html $(INFO_FILE)
 
 $(TOP_PDF_FILE): $(XML_FILES)
 
@@ -169,6 +182,10 @@ html: gifs $(HTML_REF_MAN_FILE)
 
 man: $(MAN1_FILES) $(MAN3_FILES)
 
+ref_man: ref_man.xml
+part: part.xml
+specs: specs.xml
+
 gifs: $(GIF_FILES:%=$(HTMLDIR)/%)
 
 $(INFO_FILE): $(INFO_FILE_SRC) $(ERL_TOP)/make/$(TARGET)/otp.mk
@@ -196,6 +213,19 @@ $(SPECDIR)/specs_%.xml:
 $(XMLDIR)/%.xml: ../../emulator/internal_doc/%.md $(ERL_TOP)/make/emd2exml
 	$(ERL_TOP)/make/emd2exml $< $@
 
+ref_man.xml: ref_man.xml.src
+	($(PERL) -p -e 's?%ESOCK_USE_SOCKET_XML%?$(ESOCK_USE_SOCKET_XML)?' \
+            $<) > $@
+
+part.xml: part.xml.src
+	($(PERL) -p -e 's?%ESOCK_USE_SOCKET_USAGE_XML%?$(ESOCK_USE_SOCKET_USAGE_XML)?' \
+            $<) > $@
+
+specs.xml: specs.xml.src
+	($(PERL) -p -e 's?%ESOCK_USE_SOCKET_SPECS_XML%?$(ESOCK_USE_SOCKET_SPECS_XML)?' \
+            $<) > $@
+
+
 # ----------------------------------------------------
 # Release Target
 # ----------------------------------------------------
diff --git a/erts/doc/src/net.xml b/erts/doc/src/net.xml
deleted file mode 100644
index 6fbc37076c..0000000000
--- a/erts/doc/src/net.xml
+++ /dev/null
@@ -1,129 +0,0 @@
-<?xml version="1.0" encoding="utf-8" ?>
-<!DOCTYPE erlref SYSTEM "erlref.dtd">
-
-<erlref>
-  <header>
-    <copyright>
-      <year>2018</year><year>2018</year>
-      <holder>Ericsson AB. All Rights Reserved.</holder>
-    </copyright>
-    <legalnotice>
-      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
-
-      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>
-
-    <title>net</title>
-    <prepared></prepared>
-    <docno></docno>
-    <date></date>
-    <rev></rev>
-    <file>net.xml</file>
-  </header>
-  <module since="OTP 22.0">net</module>
-  <modulesummary>Network interface.</modulesummary>
-  <description>
-    <p>This module provides an API for the network interface.</p>
-    <note>
-      <p>There is currently <em>no</em> support for Windows. </p>
-    </note>
-  </description>
-
-  <datatypes>
-    <datatype>
-      <name name="address_info"/>
-    </datatype>
-    <datatype>
-      <name name="name_info"/>
-    </datatype>
-    <datatype>
-      <name name="name_info_flags"/>
-    </datatype>
-    <datatype>
-      <name name="name_info_flag"/>
-    </datatype>
-    <datatype>
-      <name name="name_info_flag_ext"/>
-    </datatype>
-    <datatype>
-      <name name="network_interface_name"/>
-    </datatype>
-    <datatype>
-      <name name="network_interface_index"/>
-    </datatype>
-  </datatypes>
-
-  <funcs>
-    <func>
-      <name name="gethostname" arity="0"/>
-      <fsummary>Get hostname.</fsummary>
-      <desc>
-        <p>Returns the name of the current host.</p>
-      </desc>
-    </func>
-
-    <func>
-      <name name="getnameinfo" arity="1" since="OTP 22.0"/>
-      <name name="getnameinfo" arity="2" since="OTP 22.0"/>
-      <fsummary>Address-to-name transaltion.</fsummary>
-      <desc>
-        <p>Address-to-name translation in a protocol-independant manner.</p>
-	<p>This function is the inverse of
-	<seealso marker="#getaddrinfo/1"><c>getaddrinfo</c></seealso>.
-	It converts a socket address to a corresponding host and service.</p>
-      </desc>
-    </func>
-
-    <func>
-      <name name="getaddrinfo" arity="1" since="OTP 22.0"/>
-      <name name="getaddrinfo" arity="2" clause_i="1" since="OTP 22.0"/>
-      <name name="getaddrinfo" arity="2" clause_i="2" since="OTP 22.0"/>
-      <name name="getaddrinfo" arity="2" clause_i="3" since="OTP 22.0"/>
-      <fsummary>Network address and service transation.</fsummary>
-      <desc>
-	<p>Network address and service translation.</p>
-	<p>This function is the inverse of
-	<seealso marker="#getnameinfo/1"><c>getnameinfo</c></seealso>.
-	It converts host and service to a corresponding socket address.</p>
-	<p>One of the <c>Host</c> and <c>Service</c> may be <c>undefined</c>
-	but <em>not</em> both.</p>
-      </desc>
-    </func>
-
-    <func>
-      <name name="if_name2index" arity="1" since="OTP 22.0"/>
-      <fsummary>Mappings between network interface names and indexes.</fsummary>
-      <desc>
-        <p>Mappings between network interface names and indexes.</p>
-      </desc>
-    </func>
-
-    <func>
-      <name name="if_index2name" arity="1" since="OTP 22.0"/>
-      <fsummary>Mappings between network interface index and names.</fsummary>
-      <desc>
-        <p>Mappings between network interface index and names.</p>
-      </desc>
-    </func>
-
-    <func>
-      <name name="if_names" arity="0" since="OTP 22.0"/>
-      <fsummary>Get network interface names and indexes.</fsummary>
-      <desc>
-        <p>Get network interface names and indexes.</p>
-      </desc>
-    </func>
-
-  </funcs>
-
-</erlref>
-
diff --git a/erts/doc/src/part.xml b/erts/doc/src/part.xml.src
index f0b8a00b90..9b20beffad 100644
--- a/erts/doc/src/part.xml
+++ b/erts/doc/src/part.xml.src
@@ -4,7 +4,7 @@
 <part xmlns:xi="http://www.w3.org/2001/XInclude">
   <header>
     <copyright>
-      <year>1996</year><year>2018</year>
+      <year>1996</year><year>2019</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -42,7 +42,7 @@
   <xi:include href="tty.xml"/>
   <xi:include href="driver.xml"/>
   <xi:include href="inet_cfg.xml"/>
-  <xi:include href="socket_usage.xml"/>
+  %ESOCK_USE_SOCKET_USAGE_XML%
   <xi:include href="erl_ext_dist.xml"/>
   <xi:include href="erl_dist_protocol.xml"/>
 </part>
diff --git a/erts/doc/src/ref_man.xml b/erts/doc/src/ref_man.xml.src
index 80cdcf9145..7dd003763c 100644
--- a/erts/doc/src/ref_man.xml
+++ b/erts/doc/src/ref_man.xml.src
@@ -4,7 +4,7 @@
 <application xmlns:xi="http://www.w3.org/2001/XInclude">
   <header>
     <copyright>
-      <year>1996</year><year>2018</year>
+      <year>1996</year><year>2019</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -46,10 +46,9 @@
   <xi:include href="erts_alloc.xml"/>
   <xi:include href="escript.xml"/>
   <xi:include href="init.xml"/>
-  <xi:include href="net.xml"/>
   <xi:include href="persistent_term.xml"/>
   <xi:include href="run_erl.xml"/>
-  <xi:include href="socket.xml"/>
+  %ESOCK_USE_SOCKET_XML%
   <xi:include href="start.xml"/>
   <xi:include href="start_erl.xml"/>
   <xi:include href="werl.xml"/>
diff --git a/erts/doc/src/specs.xml b/erts/doc/src/specs.xml.src
index 68fab5edf1..54224c15f5 100644
--- a/erts/doc/src/specs.xml
+++ b/erts/doc/src/specs.xml.src
@@ -5,8 +5,7 @@
   <xi:include href="../specs/specs_erl_tracer.xml"/>
   <xi:include href="../specs/specs_init.xml"/>
   <xi:include href="../specs/specs_persistent_term.xml"/>
-  <xi:include href="../specs/specs_socket.xml"/>
-  <xi:include href="../specs/specs_net.xml"/>
+  %ESOCK_USE_SOCKET_SPECS_XML%
   <xi:include href="../specs/specs_zlib.xml"/>
   <xi:include href="../specs/specs_atomics.xml"/>
   <xi:include href="../specs/specs_counters.xml"/>