From 39540e7c380f6cb218a2ec6324f6296fa8327dba Mon Sep 17 00:00:00 2001
From: Micael Karlberg <bmk@erlang.org>
Date: Thu, 23 May 2013 12:35:38 +0200
Subject: [snmp/agent] Updated open options for the mnesia mib-storage module

Updated the snmpa_mib_storage_mnesia module to handle alias
atoms for the nodes option.
Also, (git) added mib-storage behaviour ref-man.
---
 lib/snmp/doc/src/snmp_config.xml | 29 ++++++++++++++++++++++++++---
 1 file changed, 26 insertions(+), 3 deletions(-)

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

diff --git a/lib/snmp/doc/src/snmp_config.xml b/lib/snmp/doc/src/snmp_config.xml
index a88111085f..f1acebf2f7 100644
--- a/lib/snmp/doc/src/snmp_config.xml
+++ b/lib/snmp/doc/src/snmp_config.xml
@@ -326,7 +326,7 @@
 	behaviour. </p>
 	<p>Several entities (<c>mib-server</c> via the its data module and 
 	the <c>symbolic-store</c>) of the snmp agent uses this for storage 
-	of miscelaneous mib data. </p>
+	of miscelaneous mib related data dataretrieved while loading a mib. </p>
 	<p>There are several implementations provided with the agent: 
 	<c>snmpa_mib_storage_ets</c>, <c>snmpa_mib_storage_dets</c> and 
 	<c>snmpa_mib_storage_mnesia</c>. </p>
@@ -337,7 +337,8 @@
       <tag><c><![CDATA[mib_storage_options() = list() <optional>]]></c></tag>
       <item>
         <p>This is implementattion depended. That is, it depends on the 
-	module. For each module a specific set of options are valid: </p>
+	module. For each module a specific set of options are valid. 
+	For the module provided with the app, these options are supported: </p>
         <list type="bulleted">
           <item>
 	    <p><c>snmpa_mib_storage_ets</c>: <c>{dir, filename()} | {action, keep | clear}, {checksum, boolean()}</c></p>
@@ -392,7 +393,29 @@
 		<p>Default is <c>keep</c>. </p>
 	      </item>
 	      <item>
-		<p><c>nodes</c> - Defines where to open the table. </p>
+		<p><c>nodes</c> - A list of node names (or an atom 
+		describing a list of nodes) defining where to open the table. 
+		Its up to the user to ensure that mnesia is actually running 
+		on the specified nodes. </p>
+		<p>The following distinct values are recognised: </p>
+		<list>
+		  <item>
+		    <p><c>[]</c> - Translated into a list of the own node: <c>[node()]</c></p>
+		  </item>
+		  <item>
+		    <p><c>all</c> - <c>erlang:nodes()</c></p>
+		  </item>
+		  <item>
+		    <p><c>visible</c> - <c>erlang:nodes(visible)</c></p>
+		  </item>
+		  <item>
+		    <p><c>connected</c> - <c>erlang:nodes(connected)</c></p>
+		  </item>
+		  <item>
+		    <p><c>db_nodes</c> - <c>mnesia:system_info(db_nodes)</c></p>
+		  </item>
+		</list>
+		
 		<p>Default is the result of the call: <c>erlang:nodes()</c>. </p>
 	      </item>
 	    </list>
-- 
cgit v1.2.3