summaryrefslogtreecommitdiff
path: root/lib/asn1
diff options
context:
space:
mode:
authorLukas Larsson <lukas@erlang.org>2020-03-11 10:11:22 +0100
committerLukas Larsson <lukas@erlang.org>2020-03-27 11:02:23 +0100
commit0799c2b0e9ae5fce18d092a153fff884d1dd3912 (patch)
treec7c72465bd01591a9163e5ad17cea92bf3be75ec /lib/asn1
parent6c6fe8e774f7cde6d158b450fd1ad6c3129dc22e (diff)
downloaderlang-0799c2b0e9ae5fce18d092a153fff884d1dd3912.tar.gz
otp: Convert all <seealso> to more specific variants
We add `seemfa`, `seeerl`, `seetype`, `seeapp`, `seecom`, `seecref` , `seefile` and `seeguide` in order to make it easier to reason about what each link points to without examining the target. This information will then be embedded in the EEP-48 chunks for usage by other tools. The tool used can be found here: https://gist.github.com/garazdawi/68527d92ae5b37c8f129bfbdfffdfa68
Diffstat (limited to 'lib/asn1')
-rw-r--r--lib/asn1/doc/src/asn1_getting_started.xml56
-rw-r--r--lib/asn1/doc/src/asn1_spec.xmlsrc12
-rw-r--r--lib/asn1/doc/src/asn1ct.xml34
3 files changed, 51 insertions, 51 deletions
diff --git a/lib/asn1/doc/src/asn1_getting_started.xml b/lib/asn1/doc/src/asn1_getting_started.xml
index 907bf051d5..64b77b51f3 100644
--- a/lib/asn1/doc/src/asn1_getting_started.xml
+++ b/lib/asn1/doc/src/asn1_getting_started.xml
@@ -191,15 +191,15 @@ erlc -o ../asnfiles -I ../asnfiles -I /usr/local/standards/asn1 Person.asn</pre>
<item>
<p>Use maps instead of records to represent the <c>SEQUENCE</c> and
<c>SET</c> types. No <c>.hrl</c> files will be generated.
- See the Section <seealso marker="asn1_getting_started#MAP_SEQ_SET">
- Map representation for SEQUENCE and SET</seealso>
+ See the Section <seeguide marker="asn1_getting_started#MAP_SEQ_SET">
+ Map representation for SEQUENCE and SET</seeguide>
for more information.</p>
</item>
<tag><c>+asn1config</c></tag>
<item>
<p>This functionality works together with option
<c>ber</c>. It enables the specialized decodes, see Section
- <seealso marker="asn1_spec">Specialized Decode</seealso>.</p>
+ <seeguide marker="asn1_spec">Specialized Decode</seeguide>.</p>
</item>
<tag><c>+undec_rest</c></tag>
<item>
@@ -225,7 +225,7 @@ erlc -o ../asnfiles -I ../asnfiles -I /usr/local/standards/asn1 Person.asn</pre>
from the Erlang shell. Here follows a brief
description of the primary functions. For a
complete description of each function, see module <c>asn1ct</c> in
- the <seealso marker="asn1ct">ASN.1 Reference Manual</seealso>.</p>
+ the <seeerl marker="asn1ct">ASN.1 Reference Manual</seeerl>.</p>
<p>The compiler is started by <c>asn1ct:compile/1</c> with
default options, or <c>asn1ct:compile/2</c> if explicit options
are given.</p>
@@ -346,47 +346,47 @@ END </pre>
<cell align="left" valign="middle"><em>Constructed Types</em></cell>
</row>
<row>
- <cell align="left" valign="middle"><seealso marker="#BOOLEAN">BOOLEAN</seealso></cell>
- <cell align="left" valign="middle"><seealso marker="#SEQUENCE">SEQUENCE</seealso></cell>
+ <cell align="left" valign="middle"><seeguide marker="#BOOLEAN">BOOLEAN</seeguide></cell>
+ <cell align="left" valign="middle"><seeguide marker="#SEQUENCE">SEQUENCE</seeguide></cell>
</row>
<row>
- <cell align="left" valign="middle"><seealso marker="#INTEGER">INTEGER</seealso></cell>
- <cell align="left" valign="middle"><seealso marker="#SET">SET</seealso></cell>
+ <cell align="left" valign="middle"><seeguide marker="#INTEGER">INTEGER</seeguide></cell>
+ <cell align="left" valign="middle"><seeguide marker="#SET">SET</seeguide></cell>
</row>
<row>
- <cell align="left" valign="middle"><seealso marker="#REAL">REAL</seealso></cell>
- <cell align="left" valign="middle"><seealso marker="#CHOICE">CHOICE</seealso></cell>
+ <cell align="left" valign="middle"><seeguide marker="#REAL">REAL</seeguide></cell>
+ <cell align="left" valign="middle"><seeguide marker="#CHOICE">CHOICE</seeguide></cell>
</row>
<row>
- <cell align="left" valign="middle"><seealso marker="#NULL">NULL</seealso></cell>
- <cell align="left" valign="middle"><seealso marker="#SOF">SET OF and SEQUENCE OF</seealso></cell>
+ <cell align="left" valign="middle"><seeguide marker="#NULL">NULL</seeguide></cell>
+ <cell align="left" valign="middle"><seeguide marker="#SOF">SET OF and SEQUENCE OF</seeguide></cell>
</row>
<row>
- <cell align="left" valign="middle"><seealso marker="#ENUMERATED">ENUMERATED</seealso></cell>
- <cell align="left" valign="middle"><seealso marker="#ANY">ANY</seealso></cell>
+ <cell align="left" valign="middle"><seeguide marker="#ENUMERATED">ENUMERATED</seeguide></cell>
+ <cell align="left" valign="middle"><seeguide marker="#ANY">ANY</seeguide></cell>
</row>
<row>
- <cell align="left" valign="middle"><seealso marker="#BIT STRING">BIT STRING</seealso></cell>
- <cell align="left" valign="middle"><seealso marker="#ANY">ANY DEFINED BY</seealso></cell>
+ <cell align="left" valign="middle"><seeguide marker="#BIT STRING">BIT STRING</seeguide></cell>
+ <cell align="left" valign="middle"><seeguide marker="#ANY">ANY DEFINED BY</seeguide></cell>
</row>
<row>
- <cell align="left" valign="middle"><seealso marker="#OCTET STRING">OCTET STRING</seealso></cell>
- <cell align="left" valign="middle"><seealso marker="#NegotiationTypes">EXTERNAL</seealso></cell>
+ <cell align="left" valign="middle"><seeguide marker="#OCTET STRING">OCTET STRING</seeguide></cell>
+ <cell align="left" valign="middle"><seeguide marker="#NegotiationTypes">EXTERNAL</seeguide></cell>
</row>
<row>
- <cell align="left" valign="middle"><seealso marker="#Character Strings">Character Strings</seealso></cell>
- <cell align="left" valign="middle"><seealso marker="#NegotiationTypes">EMBEDDED PDV</seealso></cell>
+ <cell align="left" valign="middle"><seeguide marker="#Character Strings">Character Strings</seeguide></cell>
+ <cell align="left" valign="middle"><seeguide marker="#NegotiationTypes">EMBEDDED PDV</seeguide></cell>
</row>
<row>
- <cell align="left" valign="middle"><seealso marker="#OBJECT IDENTIFIER">OBJECT IDENTIFIER</seealso></cell>
- <cell align="left" valign="middle"><seealso marker="#NegotiationTypes">CHARACTER STRING</seealso></cell>
+ <cell align="left" valign="middle"><seeguide marker="#OBJECT IDENTIFIER">OBJECT IDENTIFIER</seeguide></cell>
+ <cell align="left" valign="middle"><seeguide marker="#NegotiationTypes">CHARACTER STRING</seeguide></cell>
</row>
<row>
- <cell align="left" valign="middle"><seealso marker="#Object Descriptor">Object Descriptor</seealso></cell>
+ <cell align="left" valign="middle"><seeguide marker="#Object Descriptor">Object Descriptor</seeguide></cell>
<cell align="left" valign="middle"></cell>
</row>
<row>
- <cell align="left" valign="middle"><seealso marker="#The TIME types">TIME Types</seealso></cell>
+ <cell align="left" valign="middle"><seeguide marker="#The TIME types">TIME Types</seeguide></cell>
<cell align="left" valign="middle"></cell>
</row>
<tcaption>Supported ASN.1 Types</tcaption>
@@ -689,7 +689,7 @@ ok
[1052,1086,1081,32,1084,1072,1083,1077,1085,1100,1082,1080,
1081,32,1043,1085,1086,1084]</pre>
- <p>For details, see the <seealso marker="stdlib:unicode">unicode</seealso>
+ <p>For details, see the <seeerl marker="stdlib:unicode">unicode</seeerl>
module in STDLIB.</p>
<p>In the following example, this ASN.1 specification is used:</p>
@@ -781,8 +781,8 @@ Pdu ::= SEQUENCE {
<p>This is a 4-component structure called <c>Pdu</c>. By default,
a <c>SEQUENCE</c> is represented by a record in Erlang.
It can also be represented as a map; see
- <seealso marker="asn1_getting_started#MAP_SEQ_SET">
- Map representation for SEQUENCE and SET</seealso>.
+ <seeguide marker="asn1_getting_started#MAP_SEQ_SET">
+ Map representation for SEQUENCE and SET</seeguide>.
For each <c>SEQUENCE</c> and <c>SET</c> in an ASN.1 module an Erlang
record declaration is generated. For <c>Pdu</c>, a record
like the following is defined:</p>
@@ -1012,7 +1012,7 @@ Arr2Val = ["abc",[14,34,54],"Octets"], </pre>
<c>TYPE-IDENTIFIER.@Type</c> accomplish the same as the
deprecated <c>ANY</c>.</p>
<p>See also
- <seealso marker="#Information Object">Information object</seealso>.</p>
+ <seeguide marker="#Information Object">Information object</seeguide>.</p>
</section>
<section>
diff --git a/lib/asn1/doc/src/asn1_spec.xmlsrc b/lib/asn1/doc/src/asn1_spec.xmlsrc
index 6367376f50..85481bdb2a 100644
--- a/lib/asn1/doc/src/asn1_spec.xmlsrc
+++ b/lib/asn1/doc/src/asn1_spec.xmlsrc
@@ -83,8 +83,8 @@
file with the same name as the ASN.1 specification but with
extension <c>.asn1config</c>. This configuration file is not
the same as used for compilation of a set of files. See Section
- <seealso marker="#UndecodedPart">Writing an Exclusive Decode
- Instruction.</seealso></item>
+ <seeguide marker="#UndecodedPart">Writing an Exclusive Decode
+ Instruction.</seeguide></item>
</list>
</section>
@@ -401,15 +401,15 @@ List_Selector = [integer()]</pre>
<p>In the example, component <c>number</c> of the first of the encoded
elements in the <c>SEQUENCE OF</c> <c>buttonList</c> is selected.
This applies on the ASN.1 specification in Section
- <seealso marker="#Asn1spec">Writing an Exclusive Decode
- Instruction</seealso>.
+ <seeguide marker="#Asn1spec">Writing an Exclusive Decode
+ Instruction</seeguide>.
</p>
</section>
<section>
<title>Another Example</title>
<p>In this example, the same ASN.1 specification as in Section
- <seealso marker="#Asn1spec">Writing an Exclusive Decode Instruction</seealso>
+ <seeguide marker="#Asn1spec">Writing an Exclusive Decode Instruction</seeguide>
is used. The following is a valid selective decode instruction:</p>
<pre>
{selective_decode,
@@ -517,7 +517,7 @@ ValAction = {'Action',17,{'Button',4711,false}}.
<section>
<title>ASN.1 Specifications, Messages, and Configuration</title>
- <p>The specifications <seealso marker="#Asn1spec">GUI</seealso> and
+ <p>The specifications <seeguide marker="#Asn1spec">GUI</seeguide> and
<url href="http://www.itu.int/ITU-T/asn1/database/itu-t/h/h248/2002/MEDIA-GATEWAY-CONTROL.html">MEDIA-GATEWAY-CONTROL</url>
were used in the test.
</p>
diff --git a/lib/asn1/doc/src/asn1ct.xml b/lib/asn1/doc/src/asn1ct.xml
index eb67222c30..5121a15d26 100644
--- a/lib/asn1/doc/src/asn1ct.xml
+++ b/lib/asn1/doc/src/asn1ct.xml
@@ -48,10 +48,10 @@
and <c>OCTET STRING</c> types as Erlang terms were changed. <c>BIT
STRING</c> values are now Erlang bit strings and <c>OCTET STRING</c>
values are binaries. Also, an undecoded open type is now wrapped in
- an <c>asn1_OPENTYPE</c> tuple. For details, see <seealso
- marker="asn1_getting_started#BIT STRING">BIT STRING</seealso>, <seealso
- marker="asn1_getting_started#OCTET STRING">OCTET STRING</seealso>, and
- <seealso marker="asn1_getting_started#Information Object">ASN.1 Information Objects</seealso> in the User's Guide.</p>
+ an <c>asn1_OPENTYPE</c> tuple. For details, see <seeguide
+ marker="asn1_getting_started#BIT STRING">BIT STRING</seeguide>, <seeguide
+ marker="asn1_getting_started#OCTET STRING">OCTET STRING</seeguide>, and
+ <seeguide marker="asn1_getting_started#Information Object">ASN.1 Information Objects</seeguide> in the User's Guide.</p>
<p>To revert to the old representation of the types, use option
<c>legacy_erlang_types</c>.</p>
</note>
@@ -177,8 +177,8 @@ File3.asn</pre>
records). This option also suppresses the generation of
<c>.hrl</c> files.</p>
<p>For details, see Section
- <seealso marker="asn1_getting_started#MAP_SEQ_SET">
- Map representation for SEQUENCE and SET</seealso>
+ <seeguide marker="asn1_getting_started#MAP_SEQ_SET">
+ Map representation for SEQUENCE and SET</seeguide>
in the User's Guide.
</p>
</item>
@@ -190,8 +190,8 @@ File3.asn</pre>
This option cannot be combined with the option <c>maps</c>.
</p>
<p>For details, see Section
- <seealso marker="asn1_getting_started#BIT STRING">
- BIT STRING</seealso> in the User's Guide.
+ <seeguide marker="asn1_getting_started#BIT STRING">
+ BIT STRING</seeguide> in the User's Guide.
</p>
<p>This option implies option <c>legacy_erlang_types</c>.</p>
</item>
@@ -204,7 +204,7 @@ File3.asn</pre>
This option cannot be combined with the option <c>maps</c>.
</p>
<p>For details, see Section
- <seealso marker="asn1_getting_started#BIT STRING">BIT STRING</seealso>
+ <seeguide marker="asn1_getting_started#BIT STRING">BIT STRING</seeguide>
in the User's Guide</p>
<p>This option implies option <c>legacy_erlang_types</c>.</p>
</item>
@@ -212,10 +212,10 @@ File3.asn</pre>
<item>
<p>Use the same Erlang types to represent <c>BIT STRING</c> and
<c>OCTET STRING</c> as in OTP R16.</p>
- <p>For details, see Section <seealso
- marker="asn1_getting_started#BIT STRING">BIT STRING</seealso> and Section
- <seealso marker="asn1_getting_started#OCTET STRING">OCTET
- STRING</seealso> in the User's Guide.</p>
+ <p>For details, see Section <seeguide
+ marker="asn1_getting_started#BIT STRING">BIT STRING</seeguide> and Section
+ <seeguide marker="asn1_getting_started#OCTET STRING">OCTET
+ STRING</seeguide> in the User's Guide.</p>
<p><em>This option is not recommended for new code.</em>
This option cannot be combined with the option <c>maps</c>.</p>
</item>
@@ -270,12 +270,12 @@ File3.asn</pre>
<c>.asn1config</c>.
</p>
<p>For instructions for exclusive decode, see Section
- <seealso marker="asn1_spec#Exclusive Instruction">Exclusive
- Decode</seealso> in the User's Guide.
+ <seeguide marker="asn1_spec#Exclusive Instruction">Exclusive
+ Decode</seeguide> in the User's Guide.
</p>
<p>For instructions for selective decode, see Section
- <seealso marker="asn1_spec#Selective Instruction">Selective
- Decode</seealso> in the User's Guide.
+ <seeguide marker="asn1_spec#Selective Instruction">Selective
+ Decode</seeguide> in the User's Guide.
</p>
</item>
<tag><c>undec_rest</c></tag>