Merge branch 'bmk/snmp/add_compiler_support_agent_capabilities/OTP-8966' into bmk/snmp/snmpc/OTP-9004

Conflicts:
	lib/snmp/doc/src/notes.xml
	lib/snmp/vsn.mk

1 files changed, 41 insertions, 2 deletions

diff --git a/lib/snmp/doc/src/snmpc.xml b/lib/snmp/doc/src/snmpc.xml
index fbd0950c69..e33828326a 100644
--- a/lib/snmp/doc/src/snmpc.xml
+++ b/lib/snmp/doc/src/snmpc.xml
@@ -4,7 +4,7 @@
 <erlref>
   <header>
     <copyright>
-      <year>2004</year><year>2010</year>
+      <year>2004</year><year>2011</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -37,6 +37,7 @@
     <p>The module <c>snmpc</c> contains interface functions to the 
       SNMP toolkit MIB compiler.</p>
 
+    <marker id="compile"></marker>
   </description>
 
   <funcs>
@@ -47,7 +48,7 @@
       <type>
         <v>File = string()</v>
         <v>Options = [opt()]</v>
-        <v>opt() = db() | relaxed_row_name_assign_check() | deprecated() | description() | reference() | group_check() |  i() | il() | imports() | module() | module_identity() | outdir() |  no_defs() | verbosity() | warnings()</v>
+        <v>opt() = db() | relaxed_row_name_assign_check() | deprecated() | description() | reference() | group_check() |  i() | il() | imports() | module() | module_identity() | module_compliance() | agent_capabilities() | outdir() |  no_defs() | verbosity() | warnings()</v>
         <v>db() = {db, volatile|persistent|mnesia}</v>
         <v>deprecated() = {deprecated, bool()}</v>
         <v>relaxed_row_name_assign_check() = relaxed_row_name_assign_check</v>
@@ -59,6 +60,8 @@
         <v>imports() = imports</v>
         <v>module() = {module, atom()}</v>
         <v>module_identity() = module_identity</v>
+        <v>module_compliance() = module_compliance</v>
+        <v>agent_capabilities() = agent_capabilities</v>
         <v>no_defs() = no_defs</v>
         <v>outdir() = {outdir, dir()}</v>
         <v>verbosity() = {verbosity, silence|warning|info|log|debug|trace}</v>
@@ -77,6 +80,7 @@
 	      be used for the default instrumentation. </p>
 	    <p>Default is <c>volatile</c>. </p>
           </item>
+
           <item>
 	    <p>The option <c>deprecated</c> specifies if a deprecated 
               definition should be kept or not. If the option is 
@@ -84,6 +88,7 @@
               definitions. </p>
 	    <p>Default is <c>true</c>. </p>
           </item>
+
           <item>
 	    <p>The option <c>relaxed_row_name_assign_check</c>, if present,
 	      specifies that the row name assign check shall not be done 
@@ -94,12 +99,14 @@
 	    <p>By default it is not included, but if this option is present 
 	      it will be. </p>
           </item>
+
           <item>
 	    <p>The option <c>description</c> specifies if the text
               of the DESCRIPTION field will be included or not. </p>
 	    <p>By default it is not included, but if this option is 
 	      present it will be. </p>
           </item>
+
           <item>
 	    <p>The option <c>reference</c> specifies if the text
               of the REFERENCE field, when found in a table definition, 
@@ -108,18 +115,21 @@
 	      it will be. The reference text will be placed in the allocList 
 	      field of the mib-entry record (#me{}) for the table. </p>
           </item>
+
           <item>
 	    <p>The option <c>group_check</c> specifies whether the
 	      mib compiler should check the OBJECT-GROUP macro and
               the NOTIFICATION-GROUP macro for correctness or not.  </p>
 	    <p>Default is <c>true</c>. </p>
           </item>
+
           <item>
 	    <p>The option <c>i</c> specifies the path to search for
 	      imported (compiled) MIB files. The directories should be
               strings with a trailing directory delimiter. </p>
 	    <p>Default is <c>["./"]</c>. </p>
           </item>
+
           <item>
 	    <p>The option <c>il</c> (include_lib) also specifies a
               list of directories to search for imported MIBs. It
@@ -132,11 +142,13 @@
 	      <c><![CDATA[<snmp-home>/priv/mibs/]]></c>
               are always listed last in the include path. </p>
           </item>
+
           <item>
 	    <p>The option <c>imports</c>, if present, specifies that 
               the IMPORT statement of the MIB shall be included in the 
 	      compiled mib. </p>
           </item>
+
           <item>
 	    <p>The option <c>module</c>, if present, specifies the
               name of a module which implements all instrumentation
@@ -145,11 +157,29 @@
               functions must be the same as the corresponding managed
               object it implements. </p>
           </item>
+
           <item>
 	    <p>The option <c>module_identity</c>, if present, specifies 
               that the info part of the MODULE-IDENTITY statement of the MIB 
               shall be included in the compiled mib. </p>
           </item>
+
+          <item>
+	    <p>The option <c>module_compliance</c>, if present, specifies 
+              that the MODULE-COMPLIANCE statement of the MIB shall be included 
+              (with a mib-entry record) in the compiled mib. The mib-entry record 
+	      of the module-compliance will contain <c>reference</c> and <c>module</c> 
+	      part(s) this info in the <c>assocList</c> field). </p>
+          </item>
+
+          <item>
+	    <p>The option <c>agent_capabilities</c>, if present, specifies 
+              that the AGENT-CAPABILITIES statement of the MIB shall be included 
+              (with a mib-entry record) in the compiled mib. The mib-entry record 
+	      of the agent-capabilitie will contain <c>reference</c> and <c>modules</c> 
+	      part(s) this info in the <c>assocList</c> field). </p>
+          </item>
+
           <item>
 	    <p>The option <c>no_defs</c>, if present, specifies 
               that if a managed object does not have an instrumentation
@@ -157,6 +187,7 @@
               be used, instead this is reported as an error, and the
               compilation aborts. </p>
           </item>
+
           <item>
 	    <p>The option <c>verbosity</c> specifies the verbosity of
 	      the SNMP mib compiler. I.e. if warning, info, log, debug 
@@ -166,11 +197,13 @@
               option <c>verbosity</c> is <c>silence</c>, warning messages will
               still be shown. </p>
           </item>
+
           <item>
 	    <p>The option <c>warnings</c> specifies whether warning
               messages should be shown. </p>
 	    <p>Default is <c>true</c>. </p>
           </item>
+
         </list>
         <p>The MIB compiler understands both SMIv1 and SMIv2 MIBs.  It
           uses the <c>MODULE-IDENTITY</c> statement to determine if the MIB is
@@ -185,8 +218,11 @@
           have to be specified to <c>erlc</c> using the syntax 
           <c>+term</c>.  See <c>erlc(1)</c> for details.
           </p>
+
+	  <marker id="is_consistent"></marker>
       </desc>
     </func>
+
     <func>
       <name>is_consistent(Mibs) -> ok | {error, Reason}</name>
       <fsummary>Check for OID conflicts between MIBs</fsummary>
@@ -198,8 +234,11 @@
         <p>Checks for multiple usage of object identifiers and traps
           between MIBs.
           </p>
+
+	  <marker id="mib_to_hrl"></marker>
       </desc>
     </func>
+
     <func>
       <name>mib_to_hrl(MibName) -> ok | {error, Reason}</name>
       <fsummary>Generate constants for the objects in the MIB</fsummary>