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

6 files changed, 193 insertions, 16 deletions

diff --git a/lib/snmp/doc/src/files.mk b/lib/snmp/doc/src/files.mk
index e215143b03..494c550fff 100644
--- a/lib/snmp/doc/src/files.mk
+++ b/lib/snmp/doc/src/files.mk
@@ -42,6 +42,7 @@ XML_AGENT_REF3_FILES = \
 	snmpa_error_logger.xml \
 	snmpa_local_db.xml \
 	snmpa_mib_data.xml \
+	snmpa_mib_storage.xml \
 	snmpa_mpd.xml \
 	snmpa_network_interface.xml \
 	snmpa_network_interface_filter.xml \
diff --git a/lib/snmp/doc/src/notes.xml b/lib/snmp/doc/src/notes.xml
index 2dfe347e42..b6c7c22fb0 100644
--- a/lib/snmp/doc/src/notes.xml
+++ b/lib/snmp/doc/src/notes.xml
@@ -56,6 +56,19 @@
 	  <seealso marker="snmp_config#agent_ms_data_module">data_module</seealso>. </p>
 	  <p>Own Id: OTP-11101</p>
         </item>
+
+        <item>
+          <p>[agent] Introduced a documented behaviour for the 
+	  <seealso marker="snmpa_mib_storage">mib storage</seealso>. 
+	  At present there are three simple modules 
+	  (<c>snmpa_mib_storage_ets</c>, <c>snmpa_mib_storage_dets</c> and 
+	  <c>snmpa_mib_storage_mnesia</c>) implement�ng this behaviour, 
+	  provided with the app. </p>
+	  <p>A config option for the (agent) 
+	  <seealso marker="snmp_config#agent_mib_storage">mib storage</seealso> 
+	  has been added to the agent config options. </p>
+	  <p>Own Id: OTP-11107</p>
+        </item>
       </list>
 
     </section>
diff --git a/lib/snmp/doc/src/ref_man.xml b/lib/snmp/doc/src/ref_man.xml
index 2c12ac665a..628b30b11a 100644
--- a/lib/snmp/doc/src/ref_man.xml
+++ b/lib/snmp/doc/src/ref_man.xml
@@ -45,6 +45,7 @@
   <xi:include href="snmpa_error_logger.xml"/>
   <xi:include href="snmpa_local_db.xml"/>
   <xi:include href="snmpa_mib_data.xml"/>
+  <xi:include href="snmpa_mib_storage.xml"/>
   <xi:include href="snmpa_mpd.xml"/>
   <xi:include href="snmpa_network_interface.xml"/>
   <xi:include href="snmpa_network_interface_filter.xml"/>
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>
diff --git a/lib/snmp/doc/src/snmp_config.xml b/lib/snmp/doc/src/snmp_config.xml
index 28bfcbb3de..a88111085f 100644
--- a/lib/snmp/doc/src/snmp_config.xml
+++ b/lib/snmp/doc/src/snmp_config.xml
@@ -308,6 +308,103 @@
         <p>Default is <c>[]</c>.</p>
       </item>
 
+     <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. 
+	This option is used by two parts of the snmp agent: 
+	The mib-server and the symbolic-store. </p>
+        <p>Default is <c>[{module, snmpa_mib_storage_ets}]</c>. </p>
+      </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()]]></c></tag>
+      <item>
+        <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>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>
+
+<!--
+
+This is the old format which is "supported", but not documented, 
+in so far as it will be converted to the new format if found. 
+
       <marker id="agent_mib_storage"></marker>
       <tag><c><![CDATA[mib_storage() = ets | {ets, Dir} | {ets, Dir, Action} | dets | {dets, Dir} | {dets, Dir, Action} | mnesia | {mnesia, Nodes} | {mnesia, Nodes, Action} <optional>]]></c></tag>
       <item>
@@ -333,6 +430,7 @@
           <c>Action</c> is used to specify what shall be done if the 
           mnesia/dets table already exist.</p>
       </item>
+-->
 
       <marker id="agent_mib_server"></marker>
       <tag><c><![CDATA[mib_server() = [mib_server_opt()] <optional>]]></c></tag>
diff --git a/lib/snmp/doc/src/snmpa_mib_data.xml b/lib/snmp/doc/src/snmpa_mib_data.xml
index 4c971ec5d9..ff07a03b98 100644
--- a/lib/snmp/doc/src/snmpa_mib_data.xml
+++ b/lib/snmp/doc/src/snmpa_mib_data.xml
@@ -122,7 +122,7 @@
 
     <func>
       <name>Module:close(State) -> void()</name>
-      <fsummary>Close the mib-storage</fsummary>
+      <fsummary>Close the mib-server data instance</fsummary>
       <type>
         <v>State = term()</v>
       </type>