From b3d4a9cbddcaf4507f19fc1f9f48b2e6e8d13cd9 Mon Sep 17 00:00:00 2001
From: Micael Karlberg <bmk@erlang.org>
Date: Tue, 19 Jul 2011 15:50:27 +0200
Subject: Added marker id's in the snmpc(command) to allow linking top specific
 compiler options. Updated release notes accordingly. OTP-9437

---
 lib/snmp/doc/src/notes.xml     |  2 +-
 lib/snmp/doc/src/snmpc_cmd.xml | 33 ++++++++++++++++++++++++++++-----
 2 files changed, 29 insertions(+), 6 deletions(-)

(limited to 'lib')

diff --git a/lib/snmp/doc/src/notes.xml b/lib/snmp/doc/src/notes.xml
index 7b389929cf..b728824c44 100644
--- a/lib/snmp/doc/src/notes.xml
+++ b/lib/snmp/doc/src/notes.xml
@@ -63,7 +63,7 @@
           <p>[compiler] Added the option 
 	  <seealso marker="snmpc#compile">warnings_as_errors</seealso> 
 	  (for the SNMP MIB compiler (escript) frontend, the option 
-	  <seealso marker="snmpc(command)">--wae</seealso> is used) 
+	  <seealso marker="snmpc(command)#option_wae">--wae</seealso> is used) 
 	  which specifies whether warnings should be treated as errors. </p>
           <p>Tuncer Ayaz</p>
           <p>Own Id: OTP-9437</p>
diff --git a/lib/snmp/doc/src/snmpc_cmd.xml b/lib/snmp/doc/src/snmpc_cmd.xml
index e3064fc086..72116f8981 100644
--- a/lib/snmp/doc/src/snmpc_cmd.xml
+++ b/lib/snmp/doc/src/snmpc_cmd.xml
@@ -50,6 +50,8 @@
 	with definitions of Erlang constants for the objects in 
 	the MIB, see 
 	<seealso marker="snmpc#mib_to_hrl">mib_to_hrl/1</seealso>. </p>
+
+	<marker id="options"></marker>
       </desc>
     </func>
   </funcs>
@@ -58,15 +60,18 @@
     <title>Compiler options</title>
     <p>The following options are supported (note that most of these relate 
     to the compilation of the MIB file):</p>
+    <marker id="option_help"></marker>
     <taglist>
       <tag>--help</tag>
       <item>
         <p>Prints help info.</p>
+	<marker id="option_version"></marker>
       </item>
 
       <tag>--version</tag>
       <item>
         <p>Prints application and mib format version.</p>
+	<marker id="option_verbosity"></marker>
       </item>
 
       <tag>--verbosity <em>verbosity</em></tag>
@@ -74,11 +79,20 @@
         <p>Print debug info. </p>
 	<p><c>verbosity</c> = <c>trace</c> | <c>debug</c> | <c>log</c> | <c>info</c> | <c>silence</c></p>
 	<p>Defaults to <c>silence</c>.</p>
+	<marker id="option_warnings"></marker>
       </item>
 
       <tag>--warnings</tag>
       <item>
         <p>Print warning messages. </p>
+	<marker id="option_wae"></marker>
+      </item>
+
+      <tag>--wae</tag>
+      <item>
+        <p>Warnings as errors. 
+	Indicates that warnings shall be treated as errors. </p>
+	<marker id="option_odir"></marker>
       </item>
 
       <tag>--o <em>directory</em></tag>
@@ -86,6 +100,7 @@
         <p>The directory where the compiler should place the output files.
 	If not specified, output files will be placed in the current working
 	directory.</p>
+	<marker id="option_idir"></marker>
       </item>
 
       <tag>--i <em>Directory</em></tag>
@@ -94,6 +109,7 @@
 	By default, the current working directory is always included. </p>
 	<p>This option can be present several times, each time specifying
 	<em>one</em> path. </p>
+	<marker id="option_ildir"></marker>
       </item>
 
       <tag>--il <em>Directory</em></tag>
@@ -106,6 +122,7 @@
 	the current version may be in the system). The current directory 
 	and the "snmp-home"/priv/mibs/ are always listed last in the
         include path. </p>
+	<marker id="option_sgc"></marker>
       </item>
 
       <tag>--sgc</tag>
@@ -114,42 +131,50 @@
 	group check of the mib compiler. 
 	That is, should the OBJECT-GROUP and the NOTIFICATION-GROUP 
 	macro(s) be checked for correctness or not. </p>
+	<marker id="option_dep"></marker>
       </item>
 
       <tag>--dep</tag>
       <item>
         <p>Keep deprecated definition(s). 
 	If not specified the compiler will ignore deprecated definitions. </p>
+	<marker id="option_desc"></marker>
       </item>
 
       <tag>--desc</tag>
       <item>
         <p>The DESCRIPTION field will be included. </p>
+	<marker id="option_ref"></marker>
       </item>
 
       <tag>--ref</tag>
       <item>
         <p>The REFERENCE field will be included. </p>
+	<marker id="option_imp"></marker>
       </item>
 
       <tag>--imp</tag>
       <item>
         <p>The IMPORTS field will be included. </p>
+	<marker id="option_mi"></marker>
       </item>
 
       <tag>--mi</tag>
       <item>
         <p>The MODULE-IDENTITY field will be included. </p>
+	<marker id="option_mc"></marker>
       </item>
 
       <tag>--mc</tag>
       <item>
         <p>The MODULE-COMPLIANCE field will be included. </p>
+	<marker id="option_ac"></marker>
       </item>
 
       <tag>--ac</tag>
       <item>
         <p>The AGENT-CAPABILITIES field will be included. </p>
+	<marker id="option_mod"></marker>
       </item>
 
       <tag>--mod <em>module</em></tag>
@@ -157,6 +182,7 @@
         <p>The module which implements all the instrumentation functions. </p>
 	<p>The name of all instrumentation functions must be the 
 	same as the corresponding managed object it implements. </p>
+	<marker id="option_nd"></marker>
       </item>
 
       <tag>--nd</tag>
@@ -165,6 +191,7 @@
 	used if a managed object have no instrumentation function.
 	Instead this will be reported as an error, and the compilation 
 	aborts. </p>
+	<marker id="option_rrnac"></marker>
       </item>
 
       <tag>--rrnac</tag>
@@ -176,11 +203,7 @@
 	This means that the error will be converted to a warning. </p>
 	<p>By default it is not included, but if this option is present 
 	it will be. </p>
-      </item>
-
-      <tag>--wae</tag>
-      <item>
-        <p>Warnings as errors. Indicates that warnings shall be treated as errors. </p>
+	<marker id="see_also"></marker>
       </item>
 
     </taglist>
-- 
cgit v1.2.3