diff options
author | Björn Gustavsson <[email protected]> | 2014-03-28 06:51:36 +0100 |
---|---|---|
committer | Björn Gustavsson <[email protected]> | 2014-03-28 10:06:47 +0100 |
commit | cb236e7561d77bf5ef453af284abfabe6790d8a4 (patch) | |
tree | acc910d4e02c19501c59f79aa7357b91273cd5af /lib/asn1 | |
parent | e7a5051a43f9adcc564745c9c62f471fbdf253fb (diff) | |
download | otp-cb236e7561d77bf5ef453af284abfabe6790d8a4.tar.gz otp-cb236e7561d77bf5ef453af284abfabe6790d8a4.tar.bz2 otp-cb236e7561d77bf5ef453af284abfabe6790d8a4.zip |
Correct description of the undec_rest option
The trailing bytes returned are now always a binary. Also condense
and clean up the language.
Diffstat (limited to 'lib/asn1')
-rw-r--r-- | lib/asn1/doc/src/asn1_ug.xml | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/lib/asn1/doc/src/asn1_ug.xml b/lib/asn1/doc/src/asn1_ug.xml index 83de80e906..769d15cd02 100644 --- a/lib/asn1/doc/src/asn1_ug.xml +++ b/lib/asn1/doc/src/asn1_ug.xml @@ -298,13 +298,13 @@ erlc -o ../asnfiles -I ../asnfiles -I /usr/local/standards/asn1 Person.asn </item> <tag><c>+undec_rest</c></tag> <item> - <p>A buffer that holds a message, being decoded may - also have some following bytes. Now it is possible to get - those following bytes returned together with the decoded - value. If an asn1 spec is compiled with this option a tuple - <c>{ok,Value,Rest}</c> is returned. <c>Rest</c> may be a - list or a binary. Earlier versions of the compiler ignored - those following bytes.</p> + <p>A buffer that holds a message being decoded may also have + trailing bytes. If those trailing bytes are important they + can be returned along with the decoded value by compiling + the ASN.1 specification with the <c>+undec_rest</c> option. + The return value from the decoder will be + <c>{ok,Value,Rest}</c> where <c>Rest</c> is a binary + containing the trailing bytes.</p> </item> <tag><c>+'Any Erlc Option'</c></tag> <item> |