diff options
author | Björn Gustavsson <bjorn@erlang.org> | 2015-05-22 14:20:31 +0200 |
---|---|---|
committer | Björn Gustavsson <bjorn@erlang.org> | 2015-05-22 14:20:31 +0200 |
commit | b1523a416b98808407a8dc8f063d072fdb67e2fa (patch) | |
tree | c4842bbb48dacf718807147061129879b7148b32 /lib/asn1 | |
parent | 48f43e50628a746265c18bea38b311c5c3098ed4 (diff) | |
download | erlang-b1523a416b98808407a8dc8f063d072fdb67e2fa.tar.gz |
asn1 doc: Alert users of limitations in test and value functions
Add a note about the limitations of the asn1ct:test/1,2,3 and
asn1ct:value/2 functions.
Diffstat (limited to 'lib/asn1')
-rw-r--r-- | lib/asn1/doc/src/asn1ct.xml | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/lib/asn1/doc/src/asn1ct.xml b/lib/asn1/doc/src/asn1ct.xml index 4e0bf055fc..30808a5ead 100644 --- a/lib/asn1/doc/src/asn1ct.xml +++ b/lib/asn1/doc/src/asn1ct.xml @@ -371,6 +371,15 @@ File3.asn</pre> representation of a value of the <c>ASN.1</c> type <c>Type</c>. The value is a random value and subsequent calls to this function will for most types return different values.</p> + <note> + <p>Currently, the <c>value</c> function has many limitations. + Essentially, it will mostly work for old specifications based + on the 1997 standard for ASN.1, but not for most modern-style + applications. Another limitation is that the <c>value</c> function + may not work if options that change code generations strategies + such as the options <c>macro_name_prefix</c> and + <c>record_name_prefix</c> have been used.</p> + </note> </desc> </func> @@ -391,6 +400,15 @@ File3.asn</pre> This function is useful during test to secure that the generated encode and decode functions as well as the general runtime support work as expected.</p> + <note> + <p>Currently, the <c>test</c> functions have many limitations. + Essentially, they will mostly work for old specifications based + on the 1997 standard for ASN.1, but not for most modern-style + applications. Another limitation is that the <c>test</c> functions + may not work if options that change code generations strategies + such as the options <c>macro_name_prefix</c> and + <c>record_name_prefix</c> have been used.</p> + </note> <list type="bulleted"> <item> <p><c>test/1</c> iterates over all types in <c>Module</c>.</p> |