aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLukas Larsson <[email protected]>2011-07-20 17:08:30 +0200
committerLukas Larsson <[email protected]>2011-08-01 17:29:46 +0200
commitde298d1fa24b2d3f127c9f46c7549f77389f439e (patch)
tree3a6ae3041747abab96eec654f44767c2ccd2defd
parent3be549fa4d1518455d78ca009efa623ce2d3909d (diff)
downloadotp-de298d1fa24b2d3f127c9f46c7549f77389f439e.tar.gz
otp-de298d1fa24b2d3f127c9f46c7549f77389f439e.tar.bz2
otp-de298d1fa24b2d3f127c9f46c7549f77389f439e.zip
Add documentation for ber encode nif optmization
-rw-r--r--lib/asn1/doc/src/asn1_ug.xml4
-rw-r--r--lib/asn1/doc/src/asn1ct.xml10
2 files changed, 9 insertions, 5 deletions
diff --git a/lib/asn1/doc/src/asn1_ug.xml b/lib/asn1/doc/src/asn1_ug.xml
index 61e4f6062f..1b399fb641 100644
--- a/lib/asn1/doc/src/asn1_ug.xml
+++ b/lib/asn1/doc/src/asn1_ug.xml
@@ -369,7 +369,7 @@ erlc -o ../asnfiles -I ../asnfiles -I /usr/local/standards/asn1 Person.asn
<item>
<p>Together with the flags <c>ber_bin</c>
and <c>optimize</c> you choose to use a nif for considerable
- faster decode. </p>
+ faster encode and decode. </p>
</item>
<tag><c>+asn1config</c></tag>
<item>
@@ -631,7 +631,7 @@ asn1ct:decode('H323-MESSAGES','SomeChoiceType',Bytes). </pre>
</table>
<p>
- The sole compile options <c>ber</c>, <c>ber_bin</c>, <c>per</c> and
+ The compile options <c>ber</c>, <c>per</c> and
<c>driver</c> are kept for backwards compatibility and should not be
used in new code. The nif implementation which replaces the linked-in
driver has been shown to be about 5-15% faster.
diff --git a/lib/asn1/doc/src/asn1ct.xml b/lib/asn1/doc/src/asn1ct.xml
index d7c2572dc8..13e6977419 100644
--- a/lib/asn1/doc/src/asn1ct.xml
+++ b/lib/asn1/doc/src/asn1ct.xml
@@ -225,8 +225,8 @@ Binary = binary()
<item>
<p>Option valid together with <c>ber_bin</c> and <c>optimize</c>
options. It enables the use of several nifs that gives faster
- decode. Nifs are only enabled by the explicit use of the option
- <c>nif</c></p>
+ encode and decode. Nifs are only enabled by the explicit use of
+ the option <c>nif</c></p>
</item>
<tag><c>asn1config</c></tag>
<item>
@@ -269,7 +269,11 @@ Binary = binary()
<c>.set.asn</c> are exported, unless a
<c>{export,[atom()]}</c> or <c>{export_all,true}</c> option
are provided. The list of atoms are names of chosen asn1
- specs from the <c>.set.asn</c> file.</p>
+ specs from the <c>.set.asn</c> file. </p>
+ <p>When used together with <c>nif</c> for <c>ber_bin</c>, the
+ asn1 nifs will be used if the <c>asn1rt_nif</c> module is
+ available. If it is not available, a slower erlang fallback
+ will be used.</p>
</item>
<tag><c>inline</c></tag>
<item>