File 7105-snmp-manager-doc-Cleanup.patch of Package erlang
From 0d33f5ab8ec9aace1885984794e5d5a0ba82bb58 Mon Sep 17 00:00:00 2001
From: Micael Karlberg <bmk@erlang.org>
Date: Mon, 13 Sep 2021 14:12:41 +0200
Subject: [PATCH 5/5] [snmp|manager|doc] Cleanup
Removed commented out documentation for the removed (deprecated)
functions.
OTP-17612
---
lib/snmp/doc/src/snmpm.xml | 333 +------------------------------------
1 file changed, 1 insertion(+), 332 deletions(-)
diff --git a/lib/snmp/doc/src/snmpm.xml b/lib/snmp/doc/src/snmpm.xml
index 7b755c457a..961702c261 100644
--- a/lib/snmp/doc/src/snmpm.xml
+++ b/lib/snmp/doc/src/snmpm.xml
@@ -554,59 +554,10 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1
<p>For <c>SnmpInfo</c>, see the user callback function
<seeerl marker="snmpm_user#handle_report">handle_report</seeerl>.</p>
- <!-- <marker id="sync_get"></marker> -->
<marker id="async_get2"></marker>
</desc>
</func>
- <!-- DEPRECATED
- <func>
- <name since="">sync_get(UserId, TargetName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason}</name>
- <name since="">sync_get(UserId, TargetName, ContextName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason}</name>
- <name since="">sync_get(UserId, TargetName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason}</name>
- <name since="">sync_get(UserId, TargetName, ContextName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason}</name>
- <name since="">sync_get(UserId, TargetName, ContextName, Oids, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason}</name>
- <fsummary>Synchronous <c>get-request</c></fsummary>
- <type>
- <v>UserId = term()</v>
- <v>TargetName = target_name()</v>
- <v>ContextName = string()</v>
- <v>Oids = [oid()]</v>
- <v>Timeout = integer()</v>
- <v>ExtraInfo = term()</v>
- <v>SnmpReply = snmp_reply()</v>
- <v>Remaining = integer()</v>
- <v>Reason = {send_failed, ReqId, R} | {invalid_sec_info, SecInfo, SnmpInfo} | term()</v>
- <v>R = term()</v>
- <v>SecInfo = [sec_info()]</v>
- <v>sec_info() = {sec_tag(), ExpectedValue, ReceivedValue}</v>
- <v>sec_tag() = atom()</v>
- <v>ExpectedValue = ReceivedValue = term()</v>
- <v>SnmpInfo = term()</v>
- </type>
- <desc>
- <p>Synchronous <c>get-request</c>. </p>
- <p><c>Remaining</c> is the remaining time of the given or
- default timeout time.</p>
- <p>When <em>Reason</em> is <em>{send_failed, ...}</em> it means that
- the net_if process failed to send the message. This could happen
- because of any number of reasons, i.e. encoding error. <em>R</em>
- is the actual reason in this case. </p>
- <p><c>ExtraInfo</c> is an opaque data structure passed on to
- the net-if process. The net-if process included in this
- application makes, with one exception, no use of this info,
- so the only use for it in such a configuration (when using the
- built in net-if) would be tracing. The one usage exception is:
- <em>Any</em> tuple with <c>snmpm_extra_info_tag</c> as its first
- element is reserved for internal use. </p>
- <p>For <c>SnmpInfo</c>, see the user callback function
- <seeerl marker="snmpm_user#handle_report">handle_report</seeerl>.</p>
-
- <marker id="async_get2"></marker>
- </desc>
- </func>
- -->
-
<func>
<name since="OTP R14B03">async_get2(UserId, TargetName, Oids) -> {ok, ReqId} | {error, Reason}</name>
<name since="OTP R14B03">async_get2(UserId, TargetName, Oids, SendOpts) -> {ok, ReqId} | {error, Reason}</name>
@@ -645,49 +596,10 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1
for <em>this</em> request, they override any configuration done
when the agent was registered. </p>
- <!-- <marker id="async_get"></marker> -->
<marker id="sync_get_next2"></marker>
</desc>
</func>
- <!-- DEPRECATED
- <func>
- <name since="">async_get(UserId, TargetName, Oids) -> {ok, ReqId} | {error, Reason}</name>
- <name since="">async_get(UserId, TargetName, ContextName, Oids) -> {ok, ReqId} | {error, Reason}</name>
- <name since="">async_get(UserId, TargetName, Oids, Expire) -> {ok, ReqId} | {error, Reason}</name>
- <name since="">async_get(UserId, TargetName, ContextName, Oids, Expire) -> {ok, ReqId} | {error, Reason}</name>
- <name since="">async_get(UserId, TargetName, ContextName, Oids, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason}</name>
- <fsummary>Asynchronous <c>get-request</c></fsummary>
- <type>
- <v>UserId = term()</v>
- <v>TargetName = target_name()</v>
- <v>ContextName = string()</v>
- <v>Oids = [oid()]</v>
- <v>Expire = integer()</v>
- <v>ExtraInfo = term()</v>
- <v>ReqId = term()</v>
- <v>Reason = term()</v>
- </type>
- <desc>
- <p>Asynchronous <c>get-request</c>.</p>
- <p>The reply, if it arrives, will be delivered to the user
- through a call to the snmpm_user callback function
- <c>handle_pdu</c>.</p>
- <p>The <c>Expire</c> time indicates for how long the request is
- valid (after which the manager is free to delete it).</p>
- <p><c>ExtraInfo</c> is an opaque data structure passed on to
- the net-if process. The net-if process included in this
- application makes, with one exception, no use of this info,
- so the only use for it in such a configuration (when using the
- built in net-if) would be tracing. The one usage exception is:
- <em>Any</em> tuple with <c>snmpm_extra_info_tag</c> as its first
- element is reserved for internal use. </p>
-
- <marker id="sync_get_next2"></marker>
- </desc>
- </func>
- -->
-
<func>
<name since="OTP R14B03">sync_get_next2(UserId, TargetName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason}</name>
<name since="OTP R14B03">sync_get_next2(UserId, TargetName, Oids, SendOpts) -> {ok, SnmpReply, Remaining} | {error, Reason}</name>
@@ -738,50 +650,9 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1
<p>For <c>SnmpInfo</c>, see the user callback function
<seeerl marker="snmpm_user#handle_report">handle_report</seeerl>.</p>
- <!-- <marker id="sync_get_next"></marker> -->
- <marker id="async_get_next2"></marker>
- </desc>
- </func>
-
- <!-- DEPRECATED
- <func>
- <name since="">sync_get_next(UserId, TargetName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason}</name>
- <name since="">sync_get_next(UserId, TargetName, ContextName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason}</name>
- <name since="">sync_get_next(UserId, TargetName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason}</name>
- <name since="">sync_get_next(UserId, TargetName, ContextName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason}</name>
- <name since="">sync_get_next(UserId, TargetName, ContextName, Oids, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason}</name>
- <fsummary>Synchronous <c>get-next-request</c></fsummary>
- <type>
- <v>UserId = term()</v>
- <v>TargetName = target_name()</v>
- <v>ContextName = string()</v>
- <v>Oids = [oid()]</v>
- <v>Timeout = integer()</v>
- <v>ExtraInfo = term()</v>
- <v>SnmpReply = snmp_reply()</v>
- <v>Remaining = integer()</v>
- <v>Reason = {send_failed, ReqId, R} | {invalid_sec_info, SecInfo, SnmpInfo} | term()</v>
- <v>R = term()</v>
- </type>
- <desc>
- <p>Synchronous <c>get-next-request</c>. </p>
- <p><c>Remaining</c> time of the given or default timeout time.</p>
- <p>When <em>Reason</em> is <em>{send_failed, ...}</em> it means that
- the net_if process failed to send the message. This could happen
- because of any number of reasons, i.e. encoding error. <em>R</em>
- is the actual reason in this case. </p>
- <p><c>ExtraInfo</c> is an opaque data structure passed on to
- the net-if process. The net-if process included in this
- application makes, with one exception, no use of this info,
- so the only use for it in such a configuration (when using the
- built in net-if) would be tracing. The one usage exception is:
- <em>Any</em> tuple with <c>snmpm_extra_info_tag</c> as its first
- element is reserved for internal use. </p>
-
<marker id="async_get_next2"></marker>
</desc>
</func>
- -->
<func>
<name since="OTP R14B03">async_get_next2(UserId, TargetName, Oids) -> {ok, ReqId} | {error, Reason}</name>
@@ -818,48 +689,10 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1
for <em>this</em> request, they override any configuration done
when the agent was registered. </p>
- <!-- <marker id="async_get_next"></marker> -->
<marker id="sync_set2"></marker>
</desc>
</func>
- <!-- DEPRECATED
- <func>
- <name since="">async_get_next(UserId, TargetName, Oids) -> {ok, ReqId} | {error, Reason}</name>
- <name since="">async_get_next(UserId, TargetName, ContextName, Oids) -> {ok, ReqId} | {error, Reason}</name>
- <name since="">async_get_next(UserId, TargetName, Oids, Expire) -> {ok, ReqId} | {error, Reason}</name>
- <name since="">async_get_next(UserId, TargetName, ContextName, Oids, Expire) -> {ok, ReqId} | {error, Reason}</name>
- <name since="">async_get_next(UserId, TargetName, ContextName, Oids, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason}</name>
- <fsummary>Asynchronous <c>get-next-request</c></fsummary>
- <type>
- <v>UserId = term()</v>
- <v>TargetName = target_name()</v>
- <v>ContextName = string()</v>
- <v>Oids = [oid()]</v>
- <v>Expire = integer()</v>
- <v>ExtraInfo = term()</v>
- <v>ReqId = integer()</v>
- <v>Reason = term()</v>
- </type>
- <desc>
- <p>Asynchronous <c>get-next-request</c>. </p>
- <p>The reply will be delivered to the user through a call
- to the snmpm_user callback function <c>handle_pdu</c>.</p>
- <p>The <c>Expire</c> time indicates for how long the request is
- valid (after which the manager is free to delete it).</p>
- <p><c>ExtraInfo</c> is an opaque data structure passed on to
- the net-if process. The net-if process included in this
- application makes, with one exception, no use of this info,
- so the only use for it in such a configuration (when using the
- built in net-if) would be tracing. The one usage exception is:
- <em>Any</em> tuple with <c>snmpm_extra_info_tag</c> as its first
- element is reserved for internal use. </p>
-
- <marker id="sync_set2"></marker>
- </desc>
- </func>
- -->
-
<func>
<name since="OTP R14B03">sync_set2(UserId, TargetName, VarsAndVals) -> {ok, SnmpReply, Remaining} | {error, Reason}</name>
<name since="OTP R14B03">sync_set2(UserId, TargetName, VarsAndVals, SendOpts) -> {ok, SnmpReply, Remaining} | {error, Reason}</name>
@@ -913,52 +746,9 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1
<p>For <c>SnmpInfo</c>, see the user callback function
<seeerl marker="snmpm_user#handle_report">handle_report</seeerl>.</p>
- <!-- <marker id="sync_set"></marker> -->
- <marker id="async_set2"></marker>
- </desc>
- </func>
-
- <!-- DEPRECATED
- <func>
- <name since="">sync_set(UserId, TargetName, VarsAndVals) -> {ok, SnmpReply, Remaining} | {error, Reason}</name>
- <name since="">sync_set(UserId, TargetName, ContextName, VarsAndVals) -> {ok, SnmpReply, Remaining} | {error, Reason}</name>
- <name since="">sync_set(UserId, TargetName, VarsAndVals, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason}</name>
- <name since="">sync_set(UserId, TargetName, ContextName, VarsAndVals, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason}</name>
- <name since="">sync_set(UserId, TargetName, ContextName, VarsAndVals, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason}</name>
- <fsummary>Synchronous <c>set-request</c></fsummary>
- <type>
- <v>UserId = term()</v>
- <v>TargetName = target_name()</v>
- <v>ContextName = string()</v>
- <v>VarsAndVals = vars_and_vals()</v>
- <v>Timeout = integer()</v>
- <v>ExtraInfo = term()</v>
- <v>SnmpReply = snmp_reply()</v>
- <v>Remaining = integer()</v>
- <v>Reason = {send_failed, ReqId, ActualReason} | {invalid_sec_info, SecInfo, SnmpInfo} | term()</v>
- <v>ActualReason = term()</v>
- </type>
- <desc>
- <p>Synchronous <c>set-request</c>. </p>
- <p><c>Remaining</c> time of the given or default timeout time.</p>
- <p>When <em>Reason</em> is <em>{send_failed, ...}</em> it means that
- the net_if process failed to send the message. This could happen
- because of any number of reasons, i.e. encoding error. <em>R</em>
- is the actual reason in this case. </p>
- <p>When <em>var_and_val()</em> is <em>{oid(), value()}</em>, the
- manager makes an educated guess based on the loaded mibs. </p>
- <p><c>ExtraInfo</c> is an opaque data structure passed on to
- the net-if process. The net-if process included in this
- application makes, with one exception, no use of this info,
- so the only use for it in such a configuration (when using the
- built in net-if) would be tracing. The one usage exception is:
- <em>Any</em> tuple with <c>snmpm_extra_info_tag</c> as its first
- element is reserved for internal use. </p>
-
<marker id="async_set2"></marker>
</desc>
</func>
- -->
<func>
<name since="OTP R14B03">async_set2(UserId, TargetName, VarsAndVals) -> {ok, ReqId} | {error, Reason}</name>
@@ -1000,48 +790,9 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1
for <em>this</em> request, they override any configuration done
when the agent was registered. </p>
- <!-- <marker id="async_set"></marker> -->
- <marker id="sync_get_bulk2"></marker>
- </desc>
- </func>
-
- <!-- DEPRECATED
- <func>
- <name since="">async_set(UserId, TargetName, VarsAndVals) -> {ok, ReqId} | {error, Reason}</name>
- <name since="">async_set(UserId, TargetName, ContextName, VarsAndVals) -> {ok, ReqId} | {error, Reason}</name>
- <name since="">async_set(UserId, TargetName, VarsAndVals, Expire) -> {ok, ReqId} | {error, Reason}</name>
- <name since="">async_set(UserId, TargetName, ContextName, VarsAndVals, Expire) -> {ok, ReqId} | {error, Reason}</name>
- <name since="">async_set(UserId, TargetName, ContextName, VarsAndVals, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason}</name>
- <fsummary>Asynchronous <c>set-request</c></fsummary>
- <type>
- <v>UserId = term()</v>
- <v>TargetName = target_name()</v>
- <v>VarsAndVals = vars_and_vals()</v>
- <v>Expire = integer()</v>
- <v>ExtraInfo = term()</v>
- <v>ReqId = term()</v>
- <v>Reason = term()</v>
- </type>
- <desc>
- <p>Asynchronous <c>set-request</c>. </p>
- <p>The reply will be delivered to the user through a call
- to the snmpm_user callback function <c>handle_pdu</c>.</p>
- <p>The <c>Expire</c> time indicates for how long the request is
- valid (after which the manager is free to delete it).</p>
- <p>When <em>var_and_val()</em> is <em>{oid(), value()}</em>, the
- manager makes an educated guess based on the loaded mibs. </p>
- <p><c>ExtraInfo</c> is an opaque data structure passed on to
- the net-if process. The net-if process included in this
- application makes, with one exception, no use of this info,
- so the only use for it in such a configuration (when using the
- built in net-if) would be tracing. The one usage exception is:
- <em>Any</em> tuple with <c>snmpm_extra_info_tag</c> as its first
- element is reserved for internal use. </p>
-
<marker id="sync_get_bulk2"></marker>
</desc>
</func>
- -->
<func>
<name since="OTP R14B03">sync_get_bulk2(UserId, TragetName, NonRep, MaxRep, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason}</name>
@@ -1095,52 +846,10 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1
<p>For <c>SnmpInfo</c>, see the user callback function
<seeerl marker="snmpm_user#handle_report">handle_report</seeerl>.</p>
- <!-- <marker id="sync_get_bulk"></marker> -->
<marker id="async_get_bulk2"></marker>
</desc>
</func>
- <!-- DEPRECATED
- <func>
- <name since="">sync_get_bulk(UserId, TragetName, NonRep, MaxRep, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason}</name>
- <name since="">sync_get_bulk(UserId, TragetName, NonRep, MaxRep, ContextName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason}</name>
- <name since="">sync_get_bulk(UserId, TragetName, NonRep, MaxRep, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason}</name>
- <name since="">sync_get_bulk(UserId, TragetName, NonRep, MaxRep, ContextName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason}</name>
- <name since="">sync_get_bulk(UserId, TragetName, NonRep, MaxRep, ContextName, Oids, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason}</name>
- <fsummary>Synchronous <c>get-bulk-request</c></fsummary>
- <type>
- <v>UserId = term()</v>
- <v>TargetName = target_name()</v>
- <v>NonRep = integer()</v>
- <v>MaxRep = integer()</v>
- <v>ContextName = string()</v>
- <v>Oids = [oid()]</v>
- <v>Timeout = integer()</v>
- <v>ExtraInfo = term()</v>
- <v>SnmpReply = snmp_reply()</v>
- <v>Remaining = integer()</v>
- <v>Reason = {send_failed, ReqId, R} | {invalid_sec_info, SecInfo, SnmpInfo} | term()</v>
- </type>
- <desc>
- <p>Synchronous <c>get-bulk-request</c> (See RFC1905).</p>
- <p><c>Remaining</c> time of the given or default timeout time.</p>
- <p>When <em>Reason</em> is <em>{send_failed, ...}</em> it means that
- the net_if process failed to send the message. This could happen
- because of any number of reasons, i.e. encoding error. <em>R</em>
- is the actual reason in this case. </p>
- <p><c>ExtraInfo</c> is an opaque data structure passed on to
- the net-if process. The net-if process included in this
- application makes, with one exception, no use of this info,
- so the only use for it in such a configuration (when using the
- built in net-if) would be tracing. The one usage exception is:
- <em>Any</em> tuple with <c>snmpm_extra_info_tag</c> as its first
- element is reserved for internal use. </p>
-
- <marker id="async_get_bulk2"></marker>
- </desc>
- </func>
- -->
-
<func>
<name since="OTP R14B03">async_get_bulk2(UserId, TargetName, NonRep, MaxRep, Oids) -> {ok, ReqId} | {error, Reason}</name>
<name since="OTP R14B03">async_get_bulk2(UserId, TargetName, NonRep, MaxRep, Oids, SendOpts) -> {ok, ReqId} | {error, Reason}</name>
@@ -1178,49 +887,9 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1
for <em>this</em> request, they override any configuration done
when the agent was registered. </p>
- <!-- <marker id="async_get_bulk"></marker> -->
- <marker id="cancel_async_request"></marker>
- </desc>
- </func>
-
- <!-- DEPRECATED
- <func>
- <name since="">async_get_bulk(UserId, TargetName, NonRep, MaxRep, Oids) -> {ok, ReqId} | {error, Reason}</name>
- <name since="">async_get_bulk(UserId, TargetName, NonRep, MaxRep, ContextName, Oids) -> {ok, ReqId} | {error, Reason}</name>
- <name since="">async_get_bulk(UserId, TargetName, NonRep, MaxRep, Oids, Expire) -> {ok, ReqId} | {error, Reason}</name>
- <name since="">async_get_bulk(UserId, TargetName, NonRep, MaxRep, ContextName, Oids, Expire) -> {ok, ReqId} | {error, Reason}</name>
- <name since="">async_get_bulk(UserId, TargetName, NonRep, MaxRep, ContextName, Oids, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason}</name>
- <fsummary>Asynchronous <c>get-bulk-request</c></fsummary>
- <type>
- <v>UserId = term()</v>
- <v>TargetName = target_name()</v>
- <v>NonRep = integer()</v>
- <v>MaxRep = integer()</v>
- <v>ContextName = string()</v>
- <v>Oids = [oid()]</v>
- <v>Expire = integer()</v>
- <v>ExtraInfo = term()</v>
- <v>ReqId = integer()</v>
- <v>Reason = term()</v>
- </type>
- <desc>
- <p>Asynchronous <c>get-bulk-request</c> (See RFC1905).</p>
- <p>The reply will be delivered to the user through a call
- to the snmpm_user callback function <c>handle_pdu</c>.</p>
- <p>The <c>Expire</c> time indicates for how long the request is
- valid (after which the manager is free to delete it).</p>
- <p><c>ExtraInfo</c> is an opaque data structure passed on to
- the net-if process. The net-if process included in this
- application makes, with one exception, no use of this info,
- so the only use for it in such a configuration (when using the
- built in net-if) would be tracing. The one usage exception is:
- <em>Any</em> tuple with <c>snmpm_extra_info_tag</c> as its first
- element is reserved for internal use. </p>
-
<marker id="cancel_async_request"></marker>
</desc>
</func>
- -->
<func>
<name since="">cancel_async_request(UserId, ReqId) -> ok | {error, Reason}</name>
--
2.31.1
