From fcc898b0b296376167a2a2094d0a822090cfb20e Mon Sep 17 00:00:00 2001
From: Raimo Niskanen <raimo@erlang.org>
Date: Fri, 29 Aug 2014 16:41:44 +0200
Subject: Update documentation

---
 lib/snmp/doc/src/snmp_target_mib.xml | 22 ++++++++++------------
 1 file changed, 10 insertions(+), 12 deletions(-)

(limited to 'lib/snmp/doc/src/snmp_target_mib.xml')

diff --git a/lib/snmp/doc/src/snmp_target_mib.xml b/lib/snmp/doc/src/snmp_target_mib.xml
index be6fa15c73..a076ff2d8e 100644
--- a/lib/snmp/doc/src/snmp_target_mib.xml
+++ b/lib/snmp/doc/src/snmp_target_mib.xml
@@ -4,7 +4,7 @@
 <erlref>
   <header>
     <copyright>
-      <year>1998</year><year>2013</year>
+      <year>1998</year><year>2014</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -38,18 +38,18 @@
       functions for the SNMP-TARGET-MIB, 
       and functions for configuring the database. </p>
     <p>The configuration files are described in the SNMP User's Manual.</p>
+    <p>Legacy API functions <c>add_addr/10</c> that does not specify
+      transport domain, and <c>add_addr/11</c> that has got separate
+      <c>IpAddr</c> and <c>PortNumber</c> arguments still work as before
+      for backwards compatibility reasons.</p>
 
     <marker id="types"></marker>
   </description>
 
   <section>
     <title>DATA TYPES</title>
-    <code type="none"><![CDATA[
-transportDomain() = transportDomainUdpIpv4 | transportDomainUdpIpv6
-transportAddressIPv4() = [integer()], length 4
-transportAddressIPv6() = [integer()], length 8
-transportAddressMask() = [integer()], length 0 (default), 6 (IPv4) or 10 (IPv6)
-    ]]></code>
+    <p>See the <seealso marker="snmpa_conf#types">
+    data types in <c>snmpa_conf</c></seealso>.</p>
 
     <marker id="configure"></marker>
   </section>
@@ -129,20 +129,18 @@ transportAddressMask() = [integer()], length 0 (default), 6 (IPv4) or 10 (IPv6)
     </func>
 
     <func>
-      <name>add_addr(Name, Ip, Port, Timeout, Retry, TagList, Params, EngineId, TMask, MMS) -> Ret</name>
-      <name>add_addr(Name, Domain, Ip, Port, Timeout, Retry, TagList, Params, EngineId, TMask, MMS) -> Ret</name>
+      <name>add_addr(Name, Domain, Addr, Timeout, Retry, TagList, Params, EngineId, TMask, MMS) -> Ret</name>
       <fsummary>Add one target address definition</fsummary>
       <type>
         <v>Name = string()</v>
         <v>Domain = transportDomain()</v>
-        <v>Ip = transportAddressIPv4() | transportAddressIPv6() (depends on the value of Domain)</v>
-        <v>Port = integer()</v>
+	<v>Addr = transportAddress()  % Default port is 162</v>
         <v>Timeout = integer()</v>
         <v>Retry = integer()</v>
         <v>TagList = string()</v>
         <v>ParamsName = string()</v>
         <v>EngineId = string()</v>
-        <v>TMask = transportAddressMask() (depends on Domain)</v>
+        <v>TMask = transportAddressMask()  % Depends on Domain</v>
         <v>MMS = integer()</v>
         <v>Ret = {ok, Key} | {error, Reason}</v>
         <v>Key = term()</v>
-- 
cgit v1.2.3