From 5bccd012d163a98dd59191db9f69134ccef49faf Mon Sep 17 00:00:00 2001
From: Micael Karlberg <bmk@erlang.org>
Date: Tue, 12 Jul 2011 16:05:52 +0200
Subject: Fixed release notes and API documentation for tdomain.xs

---
 lib/snmp/doc/src/notes.xml |  8 +++++---
 lib/snmp/doc/src/snmpm.xml | 29 +++++++++++++++++------------
 2 files changed, 22 insertions(+), 15 deletions(-)

(limited to 'lib')

diff --git a/lib/snmp/doc/src/notes.xml b/lib/snmp/doc/src/notes.xml
index facb9029f5..7e4099c7a8 100644
--- a/lib/snmp/doc/src/notes.xml
+++ b/lib/snmp/doc/src/notes.xml
@@ -48,10 +48,12 @@
 	  The transport domains was assumed to be IPv4 (transportDomainUdpIpv4).
 	  This has now been changed so that it can also be IPv6 
 	  (transportDomainUdpIpv6). 
-	  To facilitate this, the <c>transportDomain</c> is now a (new) 
-	  valid option when 
+	  To facilitate this, the transport domain, <c>tdomain</c>, 
+	  is now a (new) valid option when 
 	  <seealso marker="snmpm#register_agent">registering</seealso>
-	  a new agent. </p>
+	  a new agent (and 
+	  <seealso marker="snmpm#update_agent_info">updating</seealso> 
+	  agent info). </p>
 	  <p>This also mean that the transport behaviour has changed. </p>
           <p>Own Id: OTP-9305</p>
           <p>Aux Id: Seq 11847</p>
diff --git a/lib/snmp/doc/src/snmpm.xml b/lib/snmp/doc/src/snmpm.xml
index 6162f0d592..c36a1b2a24 100644
--- a/lib/snmp/doc/src/snmpm.xml
+++ b/lib/snmp/doc/src/snmpm.xml
@@ -283,27 +283,27 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv
         <v>TargetName = target_name()</v>
         <v>Config = [agent_config()]</v>
         <v>agent_config() = {Item, Val}</v>
-        <v>Item = engine_id | address | port | community | timeout | max_message_size | version | sec_model | sec_name | sec_level</v>
+        <v>Item = engine_id | address | port | community | timeout | max_message_size | version | sec_model | sec_name | sec_level | tdomain</v>
         <v>Val = term()</v>
         <v>Reason = term()</v>
       </type>
       <desc>
         <p>Explicitly instruct the manager to handle this agent, with
-          <c>UserId</c> as the responsible user. </p>
-        <p>Called to instruct the manager that this agent 
-          shall be handled. This function is used when
-          the user knows in advance which agents the
-          manager shall handle.
-          Note that there is an alternate way to do the same thing:
-          Add the agent to the manager config files (see 
-          <seealso marker="snmp_manager_config_files#agents">agents.conf</seealso>).</p>
+	<c>UserId</c> as the responsible user. </p>
+        <p>Called to instruct the manager that this agent shall be handled. 
+	This function is used when the user knows in advance which agents 
+	the manager shall handle.
+	Note that there is an alternate way to do the same thing:
+	Add the agent to the manager config files (see 
+	<seealso marker="snmp_manager_config_files#agents">agents.conf</seealso>).</p>
         <p><c>TargetName</c> is a non-empty string, 
-          uniquely identifying the agent. </p>
-        <p>The type of <c>Val</c> depends on <c>Item</c>: </p>
+	uniquely identifying the agent. </p>
+	<p>The type of <c>Val</c> depends on <c>Item</c>: </p>
 <code type="none"><![CDATA[
 [mandatory] engine_id = string()
 [mandatory] address = ip_address()
 [optional]  port = integer()
+[optional]  tdomain = transportDomainUdpIpv4 | transportDomainUdpIpv6
 [optional]  community = string()
 [optional]  timeout = integer() | snmp_timer()
 [optional]  max_message_size = integer()
@@ -312,7 +312,9 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv
 [optional]  sec_name = string() 
 [optional]  sec_level = noAuthNoPriv | authNoPriv | authPriv
 ]]></code>
-        <p>Note that if no <c>Port</c> is given, the default value is used.</p>
+        <p>Note that if no <c>tdomain</c> is given, the default value,
+	<c>transportDomainUdpIpv4</c>, is used.</p>
+        <p>Note that if no <c>port</c> is given, the default value is used.</p>
 
         <marker id="unregister_agent"></marker>
       </desc>
@@ -364,6 +366,9 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv
       <desc>
         <p>Update agent config. The function <c>update_agent_info/3</c> 
 	should be used when several values needs to be updated atomically. </p>
+	<p>See function 
+	<seealso marker="#register_agent">register_agent</seealso>) 
+	for more info about what kind of items are allowed. </p>
 
         <marker id="which_agents"></marker>
       </desc>
-- 
cgit v1.2.3