aboutsummaryrefslogtreecommitdiffstats
path: root/lib/sasl/doc/src
diff options
context:
space:
mode:
Diffstat (limited to 'lib/sasl/doc/src')
-rw-r--r--lib/sasl/doc/src/notes.xml86
-rw-r--r--lib/sasl/doc/src/rb.xml86
2 files changed, 150 insertions, 22 deletions
diff --git a/lib/sasl/doc/src/notes.xml b/lib/sasl/doc/src/notes.xml
index 15387c1232..e528af2522 100644
--- a/lib/sasl/doc/src/notes.xml
+++ b/lib/sasl/doc/src/notes.xml
@@ -4,7 +4,7 @@
<chapter>
<header>
<copyright>
- <year>2004</year><year>2009</year>
+ <year>2004</year><year>2010</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
@@ -13,12 +13,12 @@
compliance with the License. You should have received a copy of the
Erlang Public License along with this software. If not, it can be
retrieved online at http://www.erlang.org/.
-
+
Software distributed under the License is distributed on an "AS IS"
basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
the License for the specific language governing rights and limitations
under the License.
-
+
</legalnotice>
<title>SASL Release Notes</title>
@@ -30,6 +30,86 @@
</header>
<p>This document describes the changes made to the SASL application.</p>
+<section><title>SASL 2.1.9.2</title>
+
+ <section><title>Fixed Bugs and Malfunctions</title>
+ <list>
+ <item>
+ <p>In R13B04 sys:get_status was modified to invoke
+ format_status/2 in the callback module if the module
+ exports that function. This resulted in a change to the
+ term returned from calling sys:get_status on the
+ supervisor module, since supervisor is a gen_server and
+ gen_server exports format_status. The sasl
+ release_handler_1 module had a dependency on the
+ pre-R13B04 term returned by sys:get_status when invoked
+ on a supervisor, so the R13B04 change broke that
+ dependency.</p>
+ <p>This problem has been fixed by change
+ release_handler_1 to handle both the pre-R13B04 and
+ R13B04 terms that sys:get_status can return from a
+ supervisor.</p>
+ <p>
+ Own Id: OTP-8619 Aux Id: seq11570 </p>
+ </item>
+ </list>
+ </section>
+
+</section>
+
+<section><title>SASL 2.1.9.1</title>
+
+ <section><title>Improvements and New Features</title>
+ <list>
+ <item>
+ <p>Use an infinity timeout in all calls to
+ <c>gen_server:call()</c> in the <c>sasl</c>
+ application.</p>
+ <p>
+ Own Id: OTP-8506 Aux Id: seq11509 </p>
+ </item>
+ </list>
+ </section>
+
+</section>
+
+<section><title>SASL 2.1.9</title>
+
+ <section><title>Improvements and New Features</title>
+ <list>
+ <item>
+ <p>
+ The <c>re:grep/1</c> function now uses the '<c>re</c>'
+ module instead of the deprecated '<c>regexp</c>' module.
+ There are new functions <c>rb:filter/1</c> and
+ <c>rb:filter/2</c> for easier filtering of reports.
+ (Thanks to Alvaro Videla.)</p>
+ <p>
+ Own Id: OTP-8443</p>
+ </item>
+ <item>
+ <p>
+ There is new function <c>sasl_report:format_report/3</c>
+ that works like the existing
+ <c>sasl_report:write_report/3</c> function except that it
+ returns a formatted string. Note that there is currently
+ no documentation for the <c>sasl_report</c> module.
+ (Thanks to Jay Nelson.)</p>
+ <p>
+ Own Id: OTP-8445</p>
+ </item>
+ <item>
+ <p>
+ Cleanups suggested by tidier and modernization of types
+ and specs.</p>
+ <p>
+ Own Id: OTP-8455</p>
+ </item>
+ </list>
+ </section>
+
+</section>
+
<section><title>SASL 2.1.8</title>
<section><title>Improvements and New Features</title>
diff --git a/lib/sasl/doc/src/rb.xml b/lib/sasl/doc/src/rb.xml
index 5b49a7bced..f35ceb5777 100644
--- a/lib/sasl/doc/src/rb.xml
+++ b/lib/sasl/doc/src/rb.xml
@@ -4,23 +4,21 @@
<erlref>
<header>
<copyright>
- <year>1996</year>
- <year>2007</year>
- <holder>Ericsson AB, All Rights Reserved</holder>
+ <year>1996</year><year>2010</year>
+ <holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
- The contents of this file are subject to the Erlang Public License,
- Version 1.1, (the "License"); you may not use this file except in
- compliance with the License. You should have received a copy of the
- Erlang Public License along with this software. If not, it can be
- retrieved online at http://www.erlang.org/.
+ The contents of this file are subject to the Erlang Public License,
+ Version 1.1, (the "License"); you may not use this file except in
+ compliance with the License. You should have received a copy of the
+ Erlang Public License along with this software. If not, it can be
+ retrieved online at http://www.erlang.org/.
- Software distributed under the License is distributed on an "AS IS"
- basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
- the License for the specific language governing rights and limitations
- under the License.
+ Software distributed under the License is distributed on an "AS IS"
+ basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+ the License for the specific language governing rights and limitations
+ under the License.
- The Initial Developer of the Original Code is Ericsson AB.
</legalnotice>
<title>rb</title>
@@ -43,20 +41,70 @@
</description>
<funcs>
<func>
+ <name>filter(Filters)</name>
+ <name>filter(Filters, Dates)</name>
+ <fsummary>Filter reports and displays them on the screen</fsummary>
+ <type>
+ <v>Filters = [filter()]</v>
+ <v>filter() = {Key, Value} | {Key, Value, no} | {Key, RegExp, re} | {Key, RegExp, re, no}</v>
+ <v>Key = term()</v>
+ <v>Value = term()</v>
+ <v>RegExp = string() | {string, Options} | mp(), {mp(), Options}</v>
+ <v>Dates = {DateFrom, DateTo} | {DateFrom, from} | {DateTo, to}</v>
+ <v>DateFrom = DateTo = {date(), time()}</v>
+ <v>date() and time() are the same type as in the <c>calendar</c> module</v>
+ </type>
+ <desc>
+ <p>This function displays the reports that match the provided filters.</p>
+ <p>
+ When a filter includes the <c>no</c> atom it will exclude the reports that match
+ that filter.
+ </p>
+ <p>
+ The reports are matched using the <c>proplists</c> module. The report must be a proplist
+ to be matched against any of the <c>filters()</c>.
+ </p>
+ <p>
+ If the filter is of the form <c>{Key, RegExp, re}</c> the report must contain an element with
+ <c>key = Key</c> and <c>Value</c> must match the RegExp regular expression.
+ </p>
+ <p>
+ If the Dates parameter is provided, then the reports are filtered according to the date
+ when they occurred. If Dates is of the form <c>{DateFrom, from}</c> then reports that occurred
+ after DateFrom are displayed.
+ </p>
+ <p>
+ If Dates is of the form <c>{DateTo, to}</c> then reports that occurred before DateTo
+ are displayed.
+ </p>
+ <p>
+ If two Dates are provided, then reports that occurred between those dates are returned.
+ </p>
+ <p>
+ If you only want to filter only by dates, then you can provide the empty list as the Filters
+ parameter.
+ </p>
+ <p>
+ See <c>rb:grep/1</c> for more information on the RegExp parameter.
+ </p>
+ </desc>
+ </func>
+ <func>
<name>grep(RegExp)</name>
<fsummary>Search the reports for a regular expression</fsummary>
<type>
- <v>RegExp = string()</v>
+ <v>RegExp = string() | {string, Options} | mp(), {mp(), Options}</v>
</type>
<desc>
<p>All reports containing the regular expression <c>RegExp</c>
are printed.
</p>
- <p><c>RegExp</c> is a string containing the regular
- expression. Refer to the module <c>regexp</c> in the STDLIB
- reference manual
- for a definition of valid regular expressions. They are
- essentially the same as the UNIX command <c>egrep</c>.
+ <p><c>RegExp</c> can be a string containing the regular
+ expression; a tuple with the string and the options for
+ compilation; a compiled regular expression; a compiled
+ regular expression and the options for running it.
+ Refer to the module <c>re</c> and specially the function <c>re:run/3</c>
+ for a definition of valid regular expressions and options.
</p>
</desc>
</func>