File 2652-snmp-doc-Add-descriptions-for-the-new-extr... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 2652-snmp-doc-Add-descriptions-for-the-new-extra-socket-o.patch of Package erlang (Revision da47e9ddaf3288df4fb93832238a2de6)

Currently displaying revision da47e9ddaf3288df4fb93832238a2de6 , Show latest

From 32f046b04261dfd0642a55794f5ffaed73ffaf07 Mon Sep 17 00:00:00 2001
From: Micael Karlberg <bmk@erlang.org>
Date: Mon, 23 Sep 2019 12:25:56 +0200
Subject: [PATCH 2/4] [snmp|doc] Add descriptions for the new 'extra socket
 option' option

OTP-16092
---
 lib/snmp/doc/src/snmp_app.xml    | 30 +++++++++++++++++++++---------
 lib/snmp/doc/src/snmp_config.xml | 32 ++++++++++++++++++++++----------
 2 files changed, 43 insertions(+), 19 deletions(-)

diff --git a/lib/snmp/doc/src/snmp_app.xml b/lib/snmp/doc/src/snmp_app.xml
index d5ac97ef15..d0e9e7d578 100644
--- a/lib/snmp/doc/src/snmp_app.xml
+++ b/lib/snmp/doc/src/snmp_app.xml
@@ -260,11 +260,12 @@
 <c><![CDATA[agent_net_if_options() = [agent_net_if_option()] <optional>]]></c></tag>
 <item>
 <c>agent_net_if_option() = {bind_to, bind_to()} | 
- {sndbuf, sndbuf()} | 
- {recbuf, recbuf()} | 
- {no_reuse, no_reuse()} | 
-	 {req_limit, req_limit()} |
- {filter, agent_net_if_filter_options()}</c>
+ {sndbuf, sndbuf()} | 
+ {recbuf, recbuf()} | 
+ {no_reuse, no_reuse()} | 
+	 {req_limit, req_limit()} |
+ {filter, agent_net_if_filter_options()} |
+	 {extra_sock_opts, <seealso marker="#extra_sock_opts">extra_socket_options()</seealso>}</c>
 These options are actually specific to the used module.
 The ones shown here are applicable to the default 
 <c>agent_net_if_module()</c>.
@@ -697,10 +698,11 @@
 <c><![CDATA[manager_net_if_options() = [manager_net_if_option()] <optional>]]></c></tag>
 <item>
 <c>manager_net_if_option() = {bind_to, bind_to()} | 
- {sndbuf, sndbuf()} | 
- {recbuf, recbuf()} | 
- {no_reuse, no_reuse()} |
- {filter, manager_net_if_filter_options()} </c>
+	{sndbuf, sndbuf()} | 
+	{recbuf, recbuf()} | 
+	{no_reuse, no_reuse()} |
+	{filter, manager_net_if_filter_options()} |
+	{extra_sock_opts, <seealso marker="#extra_sock_opts">extra_socket_options()</seealso>}</c>
 These options are actually specific to the used module.
 	The ones shown here are applicable to the default 
 	<c>manager_net_if_module()</c>.
@@ -833,6 +835,16 @@
 Default value is defined by <c>gen_udp</c>.
 </item>
 
+ <tag><marker id="extra_sock_opts"></marker>
+ <c><![CDATA[extra_socket_options() = list() <optional>]]></c></tag>
+ <item>
+	A list of arbitrary socket options. 
+	This list is not inspected by snmp (other then checking that
+	its a list). Its the users responsibility to ensure that these
+	are valid options and does not conflict with the "normal" options. 
+ Default is <c>[]</c>.
+ </item>
+
 <tag><marker id="note_store"></marker>
 <c><![CDATA[note_store() = [note_store_opt()] <optional>]]></c></tag>
 <item>
diff --git a/lib/snmp/doc/src/snmp_config.xml b/lib/snmp/doc/src/snmp_config.xml
index 6d4129dd06..aa9a268779 100644
--- a/lib/snmp/doc/src/snmp_config.xml
+++ b/lib/snmp/doc/src/snmp_config.xml
@@ -255,12 +255,13 @@
 <tag><marker id="agent_ni_opts"></marker>
 <c><![CDATA[agent_net_if_options() = [agent_net_if_option()] <optional>]]></c></tag>
 <item>
- <c>agent_net_if_option() = {bind_to, bind_to()} | 
- {sndbuf, sndbuf()} | 
- {recbuf, recbuf()} | 
- {no_reuse, no_reuse()} | 
-	 {req_limit, req_limit()} |
- {filter, agent_net_if_filter_options()}</c>
+	<c>agent_net_if_option() = {bind_to, bind_to()} | 
+	 {sndbuf, sndbuf()} | 
+ {recbuf, recbuf()} | 
+ {no_reuse, no_reuse()} | 
+	 {req_limit, req_limit()} |
+ {filter, agent_net_if_filter_options()} |
+	 {extra_sock_opts, <seealso marker="#extra_sock_opts">extra_socket_options()</seealso>}</c>
 These options are actually specific to the used module.
 The ones shown here are applicable to the default 
 <c>agent_net_if_module()</c>.
@@ -726,10 +727,11 @@ in so far as it will be converted to the new format if found.
 <c><![CDATA[manager_net_if_options() = [manager_net_if_option()] <optional>]]></c></tag>
 <item>
 <c>manager_net_if_option() = {bind_to, bind_to()} | 
- {sndbuf, sndbuf()} | 
- {recbuf, recbuf()} | 
- {no_reuse, no_reuse()} |
- {filter, manager_net_if_filter_options()}</c>
+ {sndbuf, sndbuf()} | 
+ {recbuf, recbuf()} | 
+ {no_reuse, no_reuse()} |
+ {filter, manager_net_if_filter_options()} |
+	 {extra_sock_opts, <seealso marker="#extra_sock_opts">extra_socket_options()</seealso>}</c>
 These options are actually specific to the used module.
 	The ones shown here are applicable to the default 
 	<c>manager_net_if_module()</c>. 
@@ -862,6 +864,16 @@ in so far as it will be converted to the new format if found.
 Default value is defined by <c>gen_udp</c>.
 </item>
 
+ <tag><marker id="extra_sock_opts"></marker>
+ <c><![CDATA[extra_socket_options() = list() <optional>]]></c></tag>
+ <item>
+	A list of arbitrary socket options. 
+	This list is not inspected by snmp (other then checking that
+	its a list). Its the users responsibility to ensure that these
+	are valid options and does not conflict with the "normal" options. 
+ Default is <c>[]</c>.
+ </item>
+
 <tag><marker id="note_store"></marker>
 <c><![CDATA[note_store() = [note_store_opt()] <optional>]]></c></tag>
 <item>
-- 
2.16.4

Places

File 2652-snmp-doc-Add-descriptions-for-the-new-extra-socket-o.patch of Package erlang (Revision da47e9ddaf3288df4fb93832238a2de6)

Places