File 1012-kernel-doc-Add-text-for-the-new-i-0-1-2-fu... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 1012-kernel-doc-Add-text-for-the-new-i-0-1-2-functions.patch of Package erlang (Revision c577547aad4fe182a4c53d158b3f41d4)

Currently displaying revision c577547aad4fe182a4c53d158b3f41d4 , Show latest

From 9ef2df22ee4a48c5f9d2b111960e9350a45d2f86 Mon Sep 17 00:00:00 2001
From: Micael Karlberg <bmk@erlang.org>
Date: Wed, 5 May 2021 16:00:25 +0200
Subject: [PATCH 2/2] [kernel|doc] Add text for the new i/0,1,2 functions

Add documentation for the new i/0,1,2 functions and the
info-keys type (used by these function(s)).

OTP-17376
---
 lib/kernel/doc/src/socket.xml | 128 ++++++++++++++++++++++++++++++++++
 1 file changed, 128 insertions(+)

diff --git a/lib/kernel/doc/src/socket.xml b/lib/kernel/doc/src/socket.xml
index 3c060ec9e3..548580381c 100644
--- a/lib/kernel/doc/src/socket.xml
+++ b/lib/kernel/doc/src/socket.xml
@@ -218,24 +218,44 @@
 </datatype>
 <datatype>
 <name name="socket_counters"/>
+ <desc></desc>
+ </datatype>
+ <datatype>
+ <name name="info_keys"/>
+ <desc>
+	
+	 Defines the information elements of the table(s) printed
+	 by the 
+	 <seemfa marker="#i/0">i/0</seemfa>, 
+	 <seemfa marker="#i/1">i/1</seemfa> and
+	 <seemfa marker="#i/2">i/2</seemfa>
+	 functions.
+	
+ </desc>
 </datatype>
 <datatype>
 <name name="socket_info"/>
+ <desc></desc>
 </datatype>
 <datatype>
 <name name="in_addr"/>
+ <desc></desc>
 </datatype>
 <datatype>
 <name name="in6_addr"/>
+ <desc></desc>
 </datatype>
 <datatype>
 <name name="sockaddr"/>
+ <desc></desc>
 </datatype>
 <datatype>
 <name name="sockaddr_in"/>
+ <desc></desc>
 </datatype>
 <datatype>
 <name name="sockaddr_in6"/>
+ <desc></desc>
 </datatype>
 <datatype>
 <name name="sockaddr_un"/>
@@ -265,21 +285,27 @@
 </datatype>
 <datatype>
 <name name="sockaddr_ll"/>
+ <desc></desc>
 </datatype>
 <datatype>
 <name name="sockaddr_recv"/>
+ <desc></desc>
 </datatype>
 <datatype>
 <name name="packet_type"/>
+ <desc></desc>
 </datatype>
 <datatype>
 <name name="port_number"/>
+ <desc></desc>
 </datatype>
 <datatype>
 <name name="in6_flow_info"/>
+ <desc></desc>
 </datatype>
 <datatype>
 <name name="in6_scope_id"/>
+ <desc></desc>
 </datatype>
 <datatype>
 <name name="msg_flag"/>
@@ -1251,6 +1277,7 @@
 </datatype>
 <datatype>
 <name name="native_value"/>
+ <desc></desc>
 </datatype>
 <datatype>
 <name name="cmsg_send"/>
@@ -1285,15 +1312,19 @@
 </datatype>
 <datatype>
 <name name="icmp_dest_unreach"/>
+ <desc></desc>
 </datatype>
 <datatype>
 <name name="icmpv6_dest_unreach"/>
+ <desc></desc>
 </datatype>
 <datatype>
 <name name="ee_origin"/>
+ <desc></desc>
 </datatype>
 <datatype>
 <name name="extended_err"/>
+ <desc></desc>
 </datatype>
 <datatype>
 <name name="posix"/>
@@ -1785,6 +1816,103 @@
 </desc>
 </func>
 
+ <func>
+ <name name="i" arity="0" since="OTP @OTP-17376@"/>
+ <fsummary>List all sockets in a table.</fsummary>
+ <desc>
+ 
+	 Print all sockets in table format in the erlang shell.
+	
+ </desc>
+ </func>
+
+ <func>
+ <name name="i" arity="1" clause_i="1"
+ since="OTP @OTP-17376@"/>
+ <fsummary>List sockets in a table.</fsummary>
+ <desc>
+ 
+	 Print all sockets in table format in the erlang shell.
+	 What information is included is defined by <c>InfoKeys</c>.
+	
+ </desc>
+ </func>
+
+ <func>
+ <name name="i" arity="1" clause_i="2"
+ since="OTP @OTP-17376@"/>
+ <fsummary>List sockets in a table.</fsummary>
+ <desc>
+ 
+	 Print a selection, based on domain, of the sockets in table format
+	 in the erlang shell.
+	
+ </desc>
+ </func>
+
+ <func>
+ <name name="i" arity="1" clause_i="3"
+ since="OTP @OTP-17376@"/>
+ <fsummary>List sockets in a table.</fsummary>
+ <desc>
+ 
+	 Print a selection, based on protocol, of the sockets
+	 in table format in the erlang shell.
+	
+ </desc>
+ </func>
+
+ <func>
+ <name name="i" arity="1" clause_i="4"
+ since="OTP @OTP-17376@"/>
+ <fsummary>List sockets in a table.</fsummary>
+ <desc>
+ 
+	 Print a selection, based on type, of the sockets
+	 in table format in the erlang shell.
+	
+ </desc>
+ </func>
+
+ <func>
+ <name name="i" arity="2" clause_i="1"
+ since="OTP @OTP-17376@"/>
+ <fsummary>List sockets in a table.</fsummary>
+ <desc>
+ 
+	 Print a selection, based on domain, of the sockets
+	 in table format in the erlang shell.
+	 What information is included is defined by <c>InfoKeys</c>.
+	
+ </desc>
+ </func>
+
+ <func>
+ <name name="i" arity="2" clause_i="2"
+ since="OTP @OTP-17376@"/>
+ <fsummary>List sockets in a table.</fsummary>
+ <desc>
+ 
+	 Print a selection, based on domain, of the sockets
+	 in table format in the erlang shell.
+	 What information is included is defined by <c>InfoKeys</c>.
+	
+ </desc>
+ </func>
+
+ <func>
+ <name name="i" arity="2" clause_i="3"
+ since="OTP @OTP-17376@"/>
+ <fsummary>List sockets in a table.</fsummary>
+ <desc>
+ 
+	 Print a selection, based on type, of the sockets
+	 in table format in the erlang shell.
+	 What information is included is defined by <c>InfoKeys</c>.
+	
+ </desc>
+ </func>
+
 <func>
 <name name="info" arity="0" since="OTP 24.0"/>
 <fsummary>Get miscellaneous socket library info.</fsummary>
-- 
2.26.2

Places

File 1012-kernel-doc-Add-text-for-the-new-i-0-1-2-functions.patch of Package erlang (Revision c577547aad4fe182a4c53d158b3f41d4)

Places