summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMicael Karlberg <bmk@erlang.org>2019-11-27 10:21:41 +0100
committerMicael Karlberg <bmk@erlang.org>2019-11-27 10:21:41 +0100
commit28a90a039dc513a702fb2825076e8e4de1df4445 (patch)
tree2e1d60b8d94bcc66d3f888313958879fc07a978d
parentc20b8930fe119b3ed14ed21c203072ef04a75c87 (diff)
parentd747e8e2c614eb4d8271539123319f17d53184a7 (diff)
downloaderlang-28a90a039dc513a702fb2825076e8e4de1df4445.tar.gz
Merge branch 'bmk/kernel/enet/20191125/make_net_doc_always_included/OTP-16294' into maint
-rw-r--r--lib/kernel/doc/src/Makefile25
-rw-r--r--lib/kernel/doc/src/net.xml4
-rw-r--r--lib/kernel/doc/src/ref_man.xml (renamed from lib/kernel/doc/src/ref_man.xml.src)2
-rw-r--r--lib/kernel/doc/src/specs.xml (renamed from lib/kernel/doc/src/specs.xml.src)2
-rw-r--r--lib/kernel/src/net.erl15
5 files changed, 23 insertions, 25 deletions
diff --git a/lib/kernel/doc/src/Makefile b/lib/kernel/doc/src/Makefile
index e18b7bc326..fe3dc9dab5 100644
--- a/lib/kernel/doc/src/Makefile
+++ b/lib/kernel/doc/src/Makefile
@@ -37,17 +37,6 @@ RELSYSDIR = $(RELEASE_PATH)/lib/$(APPLICATION)-$(VSN)
# ----------------------------------------------------
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 \
@@ -74,7 +63,7 @@ XML_REF3_FILES = application.xml \
logger_disk_log_h.xml \
logger_filters.xml \
logger_formatter.xml \
- $(XML_REF3_ESOCK_FILES) \
+ net.xml \
net_adm.xml \
net_kernel.xml \
os.xml \
@@ -153,7 +142,7 @@ SPECS_FLAGS = -I../../include
$(HTMLDIR)/%: %
$(INSTALL_DATA) $< $@
-docs: ref_man specs man pdf html
+docs: man pdf html
$(TOP_PDF_FILE): $(XML_FILES)
@@ -163,9 +152,6 @@ 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:
@@ -203,13 +189,6 @@ $(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/lib/kernel/doc/src/net.xml b/lib/kernel/doc/src/net.xml
index 6fbc37076c..425a16b104 100644
--- a/lib/kernel/doc/src/net.xml
+++ b/lib/kernel/doc/src/net.xml
@@ -36,6 +36,10 @@
<note>
<p>There is currently <em>no</em> support for Windows. </p>
</note>
+ <note>
+ <p>The content of this file is <em>only</em> valid if the system has
+ been built with 'socket' (esock) support, which is the default. </p>
+ </note>
</description>
<datatypes>
diff --git a/lib/kernel/doc/src/ref_man.xml.src b/lib/kernel/doc/src/ref_man.xml
index 72e3409123..9df51dee22 100644
--- a/lib/kernel/doc/src/ref_man.xml.src
+++ b/lib/kernel/doc/src/ref_man.xml
@@ -60,7 +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.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.src b/lib/kernel/doc/src/specs.xml
index ccb26b9458..9e258910db 100644
--- a/lib/kernel/doc/src/specs.xml.src
+++ b/lib/kernel/doc/src/specs.xml
@@ -26,7 +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.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 2c090e7631..207f023bbe 100644
--- a/lib/kernel/src/net.erl
+++ b/lib/kernel/src/net.erl
@@ -85,10 +85,17 @@
-type name_info_flag_ext() :: idn.
-type name_info() :: #{host := string(),
service := string()}.
+-ifdef(USE_ESOCK).
-type address_info() :: #{family := socket:domain(),
socktype := socket:type(),
protocol := socket:protocol(),
address := socket:sockaddr()}.
+-else.
+-type address_info() :: #{family := term(),
+ socktype := term(),
+ protocol := term(),
+ address := term()}.
+-endif.
-type network_interface_name() :: string().
-type network_interface_index() :: non_neg_integer().
@@ -178,11 +185,19 @@ gethostname() ->
getnameinfo(SockAddr) ->
getnameinfo(SockAddr, undefined).
+-ifdef(USE_ESOCK).
-spec getnameinfo(SockAddr, Flags) -> {ok, Info} | {error, Reason} when
SockAddr :: socket:sockaddr(),
Flags :: name_info_flags() | undefined,
Info :: name_info(),
Reason :: term().
+-else.
+-spec getnameinfo(SockAddr, Flags) -> {ok, Info} | {error, Reason} when
+ SockAddr :: term(),
+ Flags :: name_info_flags() | undefined,
+ Info :: name_info(),
+ Reason :: term().
+-endif.
-ifdef(USE_ESOCK).
getnameinfo(SockAddr, [] = _Flags) ->