Skip to content

Commit

Permalink
Merge branch 'bmk/snmp/snmp421_integration' into maint-r14
Browse files Browse the repository at this point in the history
* bmk/snmp/snmp421_integration:
  Fixed install directory typo for man3. Peter Lemenkov. Hans Ulrich Niedermann.
  The snmp config tool could not handle (manager) audit trail config because the option seqno was not handled. OTP-9354
  [agent] The SNMP ACM cache was not properly updated when changes where made to the VACM security-to-group, access and view-tree-family tables. OTP-9367
  Added marker id's in the snmpc(command) to allow linking top specific compiler options. Updated release notes accordingly. OTP-9437
  [manager] There was no way to specify transport domain. The transport domains was assumed to be IPv4 (transportDomainUdpIpv4). This has now been changed so that it can also be IPv6 (transportDomainUdpIpv6). To facilitate this, the transport domain, tdomain, is now a (new) valid option when registering (snmpm#register_agent) a new agent (and updating (snmpm#update_agent_info) agent info). This also mean that the transport behaviour has changed. Fixed appup file. OTP-9305
  [compiler] Make documentation for the snmpc escript regarding the the new option for warnings as errors ("--wae" in this case). Tuncer Ayaz. OTP-9437
  [compiler] Added the option warnings_as_errors which specifies whether warnings should be treated as errors. Tuncer Ayaz. OTP-9437
  Fixed unintended build to ebin dir of snmpc escript.
  Cosmetics indenting...
  Removed "crap" that somehow had gotten into the file (escape sequence).
  Fixed install of MIB compiler escript. Was incorrectly installed both in bin end ebin.
  Fixed (uncommented) test cases.
  Improved (transport) domain error reporting.
  Fixed release notes and API documentation for tdomain.xs
  transport domain config option named tdomain. Removed debug printouts. transport domain error detection.
  [manager] No way to specify transport domain. Transport domains was assumed to be IPv4. This has now been changed so that it can also be IPv6. To facilitate this, the transportDomain is now a (new) valid option. This also mean that the transport behaviour has changed. OTP-9305
  Updated version.
  [agent] Did not handle transport domains properly in some cases. OTP-9400
  Utility make target for cleanig the repo...
  ...
  • Loading branch information
Erlang/OTP committed Jul 22, 2011
2 parents 9e2b8f8 + 7ff8a86 commit 48048a6
Show file tree
Hide file tree
Showing 25 changed files with 1,051 additions and 430 deletions.
5 changes: 4 additions & 1 deletion lib/snmp/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ do_configure: configure
configure: configure.in
autoconf

.PHONY: info
.PHONY: info gclean

info:
@echo "OS: $(OS)"
Expand All @@ -76,6 +76,9 @@ info:
@echo "SNMP_VSN: $(SNMP_VSN)"
@echo "APP_VSN: $(APP_VSN)"

gclean:
git clean -fXd


# ----------------------------------------------------
# Application (source) release targets
Expand Down
4 changes: 3 additions & 1 deletion lib/snmp/doc/src/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,7 @@ $(TOP_PDF_FILE): $(XML_FILES)
pdf: $(TOP_PDF_FILE)

html: gifs $(HTML_REF_MAN_FILE)
html2: html $(INDEX_TARGET)

clean clean_docs: clean_html clean_man clean_pdf
rm -f errs core *~
Expand Down Expand Up @@ -228,6 +229,7 @@ clean_man:
clean_html:
@echo "cleaning html:"
rm -rf $(HTMLDIR)/*
rm -f $(INDEX_TARGET)

$(MAN7DIR)/%.7: $(MIBSDIR)/%.mib
@echo "processing $*"
Expand Down Expand Up @@ -286,7 +288,7 @@ release_docs_spec: docs
$(INSTALL_DATA) $(INFO_FILE) $(RELSYSDIR)
$(INSTALL_DIR) $(RELEASE_PATH)/man/man1
$(INSTALL_DATA) $(MAN1_FILES) $(RELEASE_PATH)/man/man1
$(INSTALL_DIR) $(RELEASE_PATH)/man/man
$(INSTALL_DIR) $(RELEASE_PATH)/man/man3
$(INSTALL_DATA) $(MAN3_FILES) $(RELEASE_PATH)/man/man3
$(INSTALL_DIR) $(RELEASE_PATH)/man/man6
$(INSTALL_DATA) $(MAN6_FILES) $(RELEASE_PATH)/man/man6
Expand Down
81 changes: 80 additions & 1 deletion lib/snmp/doc/src/notes.xml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,86 @@
<file>notes.xml</file>
</header>

<section>
<title>SNMP Development Toolkit 4.21</title>
<p>Version 4.21 supports code replacement in runtime from/to
version 4.20.1, 4.20 and 4.19. </p>

<section>
<title>Improvements and new features</title>
<!--
<p>-</p>
-->
<list type="bulleted">
<item>
<p>[manager] There was no way to specify transport domain.
The transport domains was assumed to be IPv4 (transportDomainUdpIpv4).
This has now been changed so that it can also be IPv6
(transportDomainUdpIpv6).
To facilitate this, the transport domain, <c>tdomain</c>,
is now a (new) valid option when
<seealso marker="snmpm#register_agent">registering</seealso>
a new agent (and
<seealso marker="snmpm#update_agent_info">updating</seealso>
agent info). </p>
<p>This also mean that the transport behaviour has changed. </p>
<p>Own Id: OTP-9305</p>
<p>Aux Id: Seq 11847</p>
</item>

<item>
<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)#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>
</item>
</list>

</section>

<section>
<title>Fixed Bugs and Malfunctions</title>
<!--
<p>-</p>
-->

<list type="bulleted">
<item>
<p>The snmp config tool could not handle (manager) audit trail config
because the option seqno was not handled. </p>
<p>Own Id: OTP-9354</p>
</item>

<item>
<p>[agent] The SNMP ACM cache was not properly updated when
changes where made to the VACM security-to-group, access and
view-tree-family tables. </p>
<p>Own Id: OTP-9367</p>
<p>Aux Id: Seq 11858</p>
</item>

<item>
<p>Fixed install directory typo for man3. </p>
<p>Peter Lemenkov</p>
<p>Hans Ulrich Niedermann</p>
<p>Own Id: OTP-9442</p>
</item>

</list>
</section>


<section>
<title>Incompatibilities</title>
<p>-</p>
</section>

</section> <!-- 4.21 -->


<section>
<title>SNMP Development Toolkit 4.20.1</title>
<p>Version 4.20.1 supports code replacement in runtime from/to
Expand All @@ -56,7 +136,6 @@
<!--
<p>-</p>
-->

<list type="bulleted">
<item>
<p>[agent] Did not handle transport domains properly in some cases,
Expand Down
15 changes: 13 additions & 2 deletions lib/snmp/doc/src/snmpc.xml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,11 @@
<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() | module_compliance() | agent_capabilities() | 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() | warnings_as_errors()</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>
Expand All @@ -66,6 +70,7 @@
<v>outdir() = {outdir, dir()}</v>
<v>verbosity() = {verbosity, silence|warning|info|log|debug|trace}</v>
<v>warnings() = {warnings, bool()}</v>
<v>warnings_as_errors() = warnings_as_errors</v>
<v>dir() = string()</v>
<v>BinFileName = string()</v>
</type>
Expand Down Expand Up @@ -200,11 +205,17 @@

<item>
<p>The option <c>warnings</c> specifies whether warning
messages should be shown. </p>
messages should be shown. </p>
<p>Default is <c>true</c>. </p>
</item>

<item>
<p>The option <c>warnings_as_errors</c>, if present, specifies
whether warnings should be treated as errors.</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
version 1 or 2.
Expand Down
28 changes: 28 additions & 0 deletions lib/snmp/doc/src/snmpc_cmd.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -58,34 +60,47 @@
<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>
<item>
<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>
<item>
<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>
Expand All @@ -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>
Expand All @@ -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>
Expand All @@ -114,49 +131,58 @@
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>
<item>
<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>
Expand All @@ -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>
Expand All @@ -176,6 +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>
<marker id="see_also"></marker>
</item>

</taglist>
Expand Down
Loading

0 comments on commit 48048a6

Please sign in to comment.