[snmp/agent] Add mib-storage behaviour ref-man documentation

1 files changed, 79 insertions, 15 deletions

diff --git a/lib/snmp/doc/src/snmp_app.xml b/lib/snmp/doc/src/snmp_app.xml
index 9cdbcc91c5..c62c8f1541 100644
--- a/lib/snmp/doc/src/snmp_app.xml
+++ b/lib/snmp/doc/src/snmp_app.xml
@@ -311,8 +311,8 @@
         <p>Default is <c>[]</c>.</p>
       </item>
 
-      <marker id="agent_mib_storage"></marker>
-      <tag><c><![CDATA[mib_storage() = [mib_storage_opt()]]]></c></tag>
+     <marker id="agent_mib_storage"></marker>
+      <tag><c><![CDATA[mib_storage() = [mib_storage_opt()] <optional>]]></c></tag>
       <item>
         <p><c>mib_storage_opt() = {module, mib_storage_module()} |  {options, list()}</c></p>
         <p>This option specifies how basic mib data is stored. 
@@ -322,21 +322,85 @@
       </item>
 
        <marker id="agent_mst_module"></marker>
-      <tag><c><![CDATA[mib_storage_module() = snmpa_mib_data_ets | snmpa_mib_data_dets | snmpa_mib_data_mnesia | module() <optional>]]></c></tag>
+      <tag><c><![CDATA[mib_storage_module() = snmpa_mib_data_ets | snmpa_mib_data_dets | snmpa_mib_data_mnesia | module()]]></c></tag>
       <item>
-        <p>Defines the callback mib data storage module of the 
-	SNMP agent mib-server as defined by the 
-	<seealso marker="snmpa_mib_data">snmpa_mib_data</seealso> 
+        <p>Defines the mib storage module of the SNMP agent as defined by the 
+	<seealso marker="snmpa_mib_storage">snmpa_mib_storage</seealso> 
 	behaviour. </p>
-	<p>At present only the default module is provided with the agent,  
-	<c>snmpa_mib_data_tttn</c>. </p>
-<!--
-	<p>Two modules is provided with the agent 
-	<c>snmpa_mib_data_tttn</c> (this is the old implementation) and 
-	<c>snmpa_mib_data_ttln</c> (for a mib tree with many holes, 
-	this algorithm can be more price efficient). </p>
--->
-        <p>Default module is <c>snmpa_mib_data_tttn</c>. </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>
+	<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>
+        <p>Default module is <c>snmpa_mib_storage_ets</c>. </p>
+      </item>
+
+       <marker id="agent_mst_options"></marker>
+      <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>
+        <list type="bulleted">
+          <item>
+	    <p><c>snmpa_mib_storage_ets</c>: <c>{dir, filename()} | {action, keep | clear}, {checksum, boolean()}</c></p>
+	    <list>
+	      <item>
+		<p><c>dir</c> - If present, points to a directory where a file 
+		to which all data in the ets table is "synced". </p>
+		<p>Also, when a table is opened this file is read, 
+		if it exists. </p>
+		<p>By default, this will <em>not</em> be used. </p> 
+	      </item>
+	      <item>
+		<p><c>action</c> - Specifies the behaviour when a non-empty 
+		file is found: Keep its content or clear it out. </p>
+		<p>Default is <c>keep</c>. </p> 
+	      </item>
+	      <item>
+		<p><c>checksum</c> - Defines if the file is checksummed 
+		or not. </p>
+		<p>Default is <c>false</c>. </p> 
+	      </item>
+	    </list>
+	  </item>
+          <item>
+	    <p><c>snmpa_mib_storage_dets</c>: <c>{dir, filename()} | {action, keep | clear}, {auto_save, default | pos_integer()} | {repair, force | boolean()}</c></p>
+	    <list>
+	      <item>
+		<p><c>dir</c> - This <em>mandatory</em> option points to a 
+		directory where to place the file of a dets table. </p>
+	      </item>
+	      <item>
+		<p><c>action</c> - Specifies the behaviour when a non-empty 
+		file is found: Keep its content or clear it out. </p>
+		<p>Default is <c>keep</c>. </p> 
+	      </item>
+	      <item>
+		<p><c>auto_save</c> - Defines the dets auto-save frequency. </p>
+		<p>Default is <c>default</c>. </p> 
+	      </item>
+	      <item>
+		<p><c>repair</c> - Defines the dets repair behaviour. </p>
+		<p>Default is <c>false</c>. </p> 
+	      </item>
+	    </list>
+	  </item>
+          <item>
+	    <p><c>snmpa_mib_storage_mnesia</c>: <c>{action, keep | clear}, {nodes, [node()]}</c></p>
+	    <list>
+	      <item>
+		<p><c>action</c> - Specifies the behaviour when a non-empty, 
+		already existing, table: Keep its content or clear it out. </p>
+		<p>Default is <c>keep</c>. </p>
+	      </item>
+	      <item>
+		<p><c>nodes</c> - Defines where to open the table. </p>
+		<p>Default is the result of the call: <c>erlang:nodes()</c>. </p>
+	      </item>
+	    </list>
+	  </item>
+        </list>
       </item>
 
       <marker id="agent_mib_server"></marker>