Merge branch 'bmk/esock/20190614/fix-net-docbuilding' into bmk/erts/esock/20190614/split_modules/OTP-15765

11 files changed, 173 insertions, 60 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/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"/>
diff --git a/erts/preloaded/ebin/erl_init.beam b/erts/preloaded/ebin/erl_init.beam
index 1d54e0cead..bc7639781c 100644
--- a/erts/preloaded/ebin/erl_init.beam
+++ b/erts/preloaded/ebin/erl_init.beam
diff --git a/erts/preloaded/src/erl_init.erl b/erts/preloaded/src/erl_init.erl
index 9fcb3969e4..dadf7dda6f 100644
--- a/erts/preloaded/src/erl_init.erl
+++ b/erts/preloaded/src/erl_init.erl
@@ -50,7 +50,9 @@ run(M, F, A) ->
     end.
 
 conditional_load(CondMod, Mods2Load) ->
-    conditional_load(CondMod, erlang:loaded(), Mods2Load).
+    Loaded = erlang:loaded(),
+    %% erlang:display({?MODULE, conditional_load, Loaded}),
+    conditional_load(CondMod, Loaded, Mods2Load).
 
 conditional_load(_CondMod, [], _Mods2LOad) ->
     ok;
diff --git a/lib/kernel/doc/src/Makefile b/lib/kernel/doc/src/Makefile
index f8867ccf25..70623ab9aa 100644
--- a/lib/kernel/doc/src/Makefile
+++ b/lib/kernel/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.
@@ -36,6 +36,18 @@ RELSYSDIR = $(RELEASE_PATH)/lib/$(APPLICATION)-$(VSN)
 # Target Specs
 # ----------------------------------------------------
 XML_APPLICATION_FILES = ref_man.xml
+
+# The doc build has problems with if-defing out modules...
+ifeq ($(USE_ESOCK),yes)
+XML_REF3_ESOCK_FILES = net.xml
+ESOCK_USE_NET_XML=<xi:include href="net.xml"\/>
+ESOCK_USE_NET_SPECS_XML=<xi:include href="../specs/specs_net.xml"/>
+else
+XML_REF3_ESOCK_FILES =
+ESOCK_USE_NET_SPECS_XML =
+ESOCK_USE_NET_XML =
+endif
+
 XML_REF3_FILES = application.xml \
 	auth.xml \
 	code.xml \
@@ -62,6 +74,7 @@ XML_REF3_FILES = application.xml \
         logger_disk_log_h.xml \
         logger_filters.xml \
         logger_formatter.xml \
+	$(XML_REF3_ESOCK_FILES) \
 	net_adm.xml \
 	net_kernel.xml \
 	os.xml \
@@ -112,6 +125,7 @@ SPECS_FILES = $(XML_REF3_FILES:%.xml=$(SPECDIR)/specs_%.xml)
 
 TOP_SPECS_FILE = specs.xml
 
+
 # ----------------------------------------------------
 # FIGURES
 # ----------------------------------------------------
@@ -138,7 +152,7 @@ SPECS_FLAGS = -I../../include
 $(HTMLDIR)/%: %
 	$(INSTALL_DATA) $< $@
 
-docs: man pdf html
+docs: ref_man specs man pdf html
 
 $(TOP_PDF_FILE): $(XML_FILES)
 
@@ -148,19 +162,32 @@ html: images $(HTML_REF_MAN_FILE)
 
 man: $(MAN3_FILES) $(MAN4_FILES) $(MAN6_FILES)
 
+ref_man: ref_man.xml
+specs: specs.xml
+
 images: $(IMAGE_FILES:%=$(HTMLDIR)/%)
 
+info:
+	@echo "XML_APPLICATION_FILES: $(XML_APPLICATION_FILES)"
+	@echo "XML_REF3_ESOCK_FILES:  $(XML_REF3_ESOCK_FILES)"
+	@echo "XML_REF3_FILES:        $(XML_REF3_FILES)"
+	@echo "XML_REF4_FILES:        $(XML_REF4_FILES)"
+	@echo "XML_REF6_FILES:        $(XML_REF6_FILES)"
+	@echo "XML_PART_FILES:        $(XML_PART_FILES)"
+	@echo "XML_CHAPTER_FILES:     $(XML_CHAPTER_FILES)"
+	@echo "BOOK_FILES:            $(BOOK_FILES)"
+
 debug opt:
 
 clean clean_docs:
 	rm -rf $(HTMLDIR)/*
 	rm -rf $(XMLDIR)
-	rm -f $(MAN3DIR)/*
-	rm -f $(MAN4DIR)/*
-	rm -f $(MAN6DIR)/*
-	rm -f $(TOP_PDF_FILE) $(TOP_PDF_FILE:%.pdf=%.fo)
-	rm -f $(SPECDIR)/*
-	rm -f errs core *~ *.eps
+	rm -f  $(MAN3DIR)/*
+	rm -f  $(MAN4DIR)/*
+	rm -f  $(MAN6DIR)/*
+	rm -f  $(TOP_PDF_FILE) $(TOP_PDF_FILE:%.pdf=%.fo)
+	rm -f  $(SPECDIR)/*
+	rm -f  errs core *~ *.eps
 
 $(SPECDIR)/specs_erl_prim_loader_stub.xml:
 	$(gen_verbose)escript $(SPECS_EXTRACTOR) $(SPECS_FLAGS) \
@@ -175,6 +202,14 @@ $(SPECDIR)/specs_zlib_stub.xml:
 	$(gen_verbose)escript $(SPECS_EXTRACTOR) $(SPECS_FLAGS) \
                 -o$(dir $@) -module zlib_stub
 
+ref_man.xml: ref_man.xml.src
+	($(PERL) -p -e 's?%ESOCK_USE_NET_XML%?$(ESOCK_USE_NET_XML)?' \
+            $<) > $@
+specs.xml: specs.xml.src
+	($(PERL) -p -e 's?%ESOCK_USE_NET_SPECS_XML%?$(ESOCK_USE_NET_SPECS_XML)?' \
+            $<) > $@
+
+
 # ----------------------------------------------------
 # Release Target
 # ----------------------------------------------------
diff --git a/erts/doc/src/net.xml b/lib/kernel/doc/src/net.xml
index 6fbc37076c..6fbc37076c 100644
--- a/erts/doc/src/net.xml
+++ b/lib/kernel/doc/src/net.xml
diff --git a/lib/kernel/doc/src/ref_man.xml b/lib/kernel/doc/src/ref_man.xml.src
index d3b947527f..72e3409123 100644
--- a/lib/kernel/doc/src/ref_man.xml
+++ b/lib/kernel/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>
@@ -60,6 +60,7 @@
   <xi:include href="logger_formatter.xml"/>
   <xi:include href="logger_std_h.xml"/>
   <xi:include href="logger_disk_log_h.xml"/>
+  %ESOCK_USE_NET_XML%
   <xi:include href="net_adm.xml"/>
   <xi:include href="net_kernel.xml"/>
   <xi:include href="os.xml"/>
diff --git a/lib/kernel/doc/src/specs.xml b/lib/kernel/doc/src/specs.xml.src
index b8c25ca53b..ccb26b9458 100644
--- a/lib/kernel/doc/src/specs.xml
+++ b/lib/kernel/doc/src/specs.xml.src
@@ -26,6 +26,7 @@
   <xi:include href="../specs/specs_logger_formatter.xml"/>
   <xi:include href="../specs/specs_logger_std_h.xml"/>
   <xi:include href="../specs/specs_logger_disk_log_h.xml"/>
+  %ESOCK_USE_NET_SPECS_XML%
   <xi:include href="../specs/specs_net_adm.xml"/>
   <xi:include href="../specs/specs_net_kernel.xml"/>
   <xi:include href="../specs/specs_os.xml"/>
diff --git a/lib/kernel/src/net.erl b/lib/kernel/src/net.erl
index ac8b600e4b..b8ffa64043 100644
--- a/lib/kernel/src/net.erl
+++ b/lib/kernel/src/net.erl
@@ -20,7 +20,13 @@
 
 -module(net).
 
--ifdef(USE_ESOCK).
+%% We should really ifdef this module depending on if we actually built
+%% the system with esock support (socket and prim_net), but our doc-building
+%% can't handle the "variables" we need (USE_ESOCK). So instead, we just
+%% leave everything hanging...
+%% If one of the "hanging" functions is called when esock has been disabled,
+%% the function will through a 'notsup' error (erlang:error/1).
+
 %% Administrative and utility functions
 -export([
 	 info/0,
@@ -36,7 +42,6 @@
          if_index2name/1,
          if_names/0
         ]).
--endif.
 
 %% Deprecated functions from the "old" net module
 -export([call/4,
@@ -46,8 +51,6 @@
 	 relay/1,
 	 sleep/1]).
 
--ifdef(USE_ESOCK).
-
 %% Should we define these here or refer to the prim_net module
 -export_type([
               address_info/0,
@@ -60,7 +63,7 @@
               network_interface_name/0,
               network_interface_index/0
              ]).
--endif.
+
 
 -deprecated({call,      4, eventually}).
 -deprecated({cast,      4, eventually}).
@@ -70,34 +73,23 @@
 -deprecated({sleep,     1, eventually}).
 
 
--ifdef(USE_ESOCK).
--type name_info_flags()         :: prim_net:name_info_flags().
--type name_info_flag()          :: prim_net:name_info_flag().
--type name_info_flag_ext()      :: prim_net:name_info_flag_ext().
--type name_info()               :: prim_net:name_info().
--type address_info()            :: prim_net:address_info().
--type network_interface_name()  :: prim_net:network_interface_name().
--type network_interface_index() :: prim_net:network_interface_index().
-
-%% -type name_info_flags()         :: [name_info_flag()|name_info_flag_ext()].
-%% -type name_info_flag()          :: namereqd |
-%%                                    dgram |
-%%                                    nofqdn |
-%%                                    numerichost |
-%%                                    nomericserv.
-%% -type name_info_flag_ext()      :: idn |
-%%                                    idna_allow_unassigned |
-%%                                    idna_use_std3_ascii_rules.
-%% -type name_info()               :: #{host    := string(),
-%%                                      service := string()}.
-%% -type address_info()            :: #{family   := socket:domain(),
-%%                                      socktype := socket:type(),
-%%                                      protocol := socket:protocol(),
-%%                                      address  := socket:sockaddr()}.
-%% -type network_interface_name()  :: string().
-%% -type network_interface_index() :: non_neg_integer().
-
--endif.
+-type name_info_flags()         :: [name_info_flag()|name_info_flag_ext()].
+-type name_info_flag()          :: namereqd |
+                                   dgram |
+                                   nofqdn |
+                                   numerichost |
+                                   nomericserv.
+-type name_info_flag_ext()      :: idn |
+                                   idna_allow_unassigned |
+                                   idna_use_std3_ascii_rules.
+-type name_info()               :: #{host    := string(),
+                                     service := string()}.
+-type address_info()            :: #{family   := socket:domain(),
+                                     socktype := socket:type(),
+                                     protocol := socket:protocol(),
+                                     address  := socket:sockaddr()}.
+-type network_interface_name()  :: string().
+-type network_interface_index() :: non_neg_integer().
 
 
 %% ===========================================================================
@@ -114,8 +106,6 @@ sleep(T) -> receive after T -> ok end.
 relay(X) -> slave:relay(X).
 
 
--ifdef(USE_ESOCK).
-
 %% ===========================================================================
 %%
 %% Administrative and utility API
@@ -124,14 +114,26 @@ relay(X) -> slave:relay(X).
 
 -spec info() -> list().
 
+-ifdef(USE_ESOCK).
 info() ->
     prim_net:info().
+-else.
+-dialyzer({nowarn_function, info/0}).
+info() ->
+    erlang:error(notsup).
+-endif.
 
 
 -spec command(Cmd :: term()) -> term().
 
+-ifdef(USE_ESOCK).
 command(Cmd) ->
     prim_net:command(Cmd).
+-else.
+-dialyzer({nowarn_function, command/1}).
+command(_Cmd) ->
+    erlang:error(notsup).
+-endif.
 
 
 
@@ -151,8 +153,14 @@ command(Cmd) ->
       HostName :: string(),
       Reason   :: term().
 
+-ifdef(USE_ESOCK).
 gethostname() ->
     prim_net:gethostname().
+-else.
+-dialyzer({nowarn_function, gethostname/0}).
+gethostname() ->
+    erlang:error(notsup).
+-endif.
 
 
 %% ===========================================================================
@@ -175,6 +183,7 @@ getnameinfo(SockAddr) ->
       Info     :: name_info(),
       Reason   :: term().
 
+-ifdef(USE_ESOCK).
 getnameinfo(SockAddr, [] = _Flags) ->
     getnameinfo(SockAddr, undefined);
 getnameinfo(#{family := Fam, addr := _Addr} = SockAddr, Flags)
@@ -184,7 +193,18 @@ getnameinfo(#{family := Fam, addr := _Addr} = SockAddr, Flags)
 getnameinfo(#{family := Fam, path := _Path} = SockAddr, Flags)
   when (Fam =:= local) andalso (is_list(Flags) orelse (Flags =:= undefined)) ->
     prim_net:getnameinfo(SockAddr, Flags).
-
+-else.
+-dialyzer({nowarn_function, getnameinfo/2}).
+getnameinfo(SockAddr, [] = _Flags) ->
+    getnameinfo(SockAddr, undefined);
+getnameinfo(#{family := Fam, addr := _Addr} = _SockAddr, Flags)
+  when ((Fam =:= inet) orelse (Fam =:= inet6)) andalso 
+       (is_list(Flags) orelse (Flags =:= undefined)) ->
+    erlang:error(notsup);
+getnameinfo(#{family := Fam, path := _Path} = _SockAddr, Flags)
+  when (Fam =:= local) andalso (is_list(Flags) orelse (Flags =:= undefined)) ->
+    erlang:error(notsup).
+-endif.
 
 
 %% ===========================================================================
@@ -216,11 +236,21 @@ getaddrinfo(Host) when is_list(Host) ->
       Info    :: [address_info()],
       Reason  :: term().
 
+-ifdef(USE_ESOCK).
 getaddrinfo(Host, Service)
   when (is_list(Host) orelse (Host =:= undefined)) andalso
        (is_list(Service) orelse (Service =:= undefined)) andalso
        (not ((Service =:= undefined) andalso (Host =:= undefined))) ->
     prim_net:getaddrinfo(Host, Service).
+-else.
+-dialyzer({nowarn_function, getaddrinfo/2}).
+getaddrinfo(Host, Service)
+  when (is_list(Host) orelse (Host =:= undefined)) andalso
+       (is_list(Service) orelse (Service =:= undefined)) andalso
+       (not ((Service =:= undefined) andalso (Host =:= undefined))) ->
+    erlang:error(notsup).
+-endif.
+
 
 
 
@@ -236,8 +266,14 @@ getaddrinfo(Host, Service)
       Idx    :: network_interface_index(),
       Reason :: term().
 
+-ifdef(USE_ESOCK).
 if_name2index(If) when is_list(If) ->
     prim_net:if_name2index(If).
+-else.
+-dialyzer({nowarn_function, if_name2index/1}).
+if_name2index(If) when is_list(If) ->
+    erlang:error(notsup).
+-endif.
 
 
 
@@ -253,8 +289,14 @@ if_name2index(If) when is_list(If) ->
       Name   :: network_interface_name(),
       Reason :: term().
 
+-ifdef(USE_ESOCK).
 if_index2name(Idx) when is_integer(Idx) ->
     prim_net:if_index2name(Idx).
+-else.
+-dialyzer({nowarn_function, if_index2name/1}).
+if_index2name(Idx) when is_integer(Idx) ->
+    erlang:error(notsup).
+-endif.
 
 
 
@@ -270,9 +312,13 @@ if_index2name(Idx) when is_integer(Idx) ->
       If     :: network_interface_name(),
       Reason :: term().
 
+-ifdef(USE_ESOCK).
 if_names() ->
     prim_net:if_names().
+-else.
+-dialyzer({nowarn_function, if_names/0}).
+if_names() ->
+    erlang:error(notsup).
+-endif.
 
 
-
--endif.