summaryrefslogtreecommitdiff
path: root/lib/tools/doc
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/tools/doc
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/tools/doc')
-rw-r--r--lib/tools/doc/src/cover.xml4
-rw-r--r--lib/tools/doc/src/cover_chapter.xml12
-rw-r--r--lib/tools/doc/src/cprof.xml12
-rw-r--r--lib/tools/doc/src/cprof_chapter.xml2
-rw-r--r--lib/tools/doc/src/erlang_mode.xml2
-rw-r--r--lib/tools/doc/src/fprof.xml8
-rw-r--r--lib/tools/doc/src/fprof_chapter.xml10
-rw-r--r--lib/tools/doc/src/instrument.xml12
-rw-r--r--lib/tools/doc/src/lcnt.xml8
-rw-r--r--lib/tools/doc/src/lcnt_chapter.xml4
-rw-r--r--lib/tools/doc/src/make.xml2
-rw-r--r--lib/tools/doc/src/notes.xml12
-rw-r--r--lib/tools/doc/src/xref.xml122
-rw-r--r--lib/tools/doc/src/xref_chapter.xml24
14 files changed, 117 insertions, 117 deletions
diff --git a/lib/tools/doc/src/cover.xml b/lib/tools/doc/src/cover.xml
index 5c4a5c2597..8073bfc528 100644
--- a/lib/tools/doc/src/cover.xml
+++ b/lib/tools/doc/src/cover.xml
@@ -387,11 +387,11 @@
</type>
<desc>
<p>This function works exactly the same way as
- <seealso marker="#analyse_to_file/1">analyse_to_file</seealso> except
+ <seemfa marker="#analyse_to_file/1">analyse_to_file</seemfa> except
that it is asynchronous instead of synchronous. The spawned process
will link with the caller when created. If an <c>Error</c> occurs
while doing the cover analysis the process will crash with the same
- error reason as <seealso marker="#analyse_to_file/1">analyse_to_file</seealso>
+ error reason as <seemfa marker="#analyse_to_file/1">analyse_to_file</seemfa>
would return.</p>
</desc>
</func>
diff --git a/lib/tools/doc/src/cover_chapter.xml b/lib/tools/doc/src/cover_chapter.xml
index 288350d899..fe7b17c1fa 100644
--- a/lib/tools/doc/src/cover_chapter.xml
+++ b/lib/tools/doc/src/cover_chapter.xml
@@ -34,7 +34,7 @@
<title>Introduction</title>
<p>The module <c>cover</c> provides a set of functions for coverage
analysis of Erlang programs, counting how many times each
- <seealso marker="#lines">executable line</seealso> is executed.</p>
+ <seeguide marker="#lines">executable line</seeguide> is executed.</p>
<p>Coverage analysis can be used to verify test cases, making sure all
relevant code is covered, and may be helpful when looking for
bottlenecks in the code.</p>
@@ -127,7 +127,7 @@ s() ->
<p>Before any analysis can take place, the involved modules must be
<em>Cover compiled</em>. This means that some extra information is
added to the module before it is compiled into a binary which then
- is <seealso marker="#loading">loaded</seealso>. The source file of
+ is <seeguide marker="#loading">loaded</seeguide>. The source file of
the module is not affected and no <c>.beam</c> file is created.</p>
<pre>
2> <input>cover:compile_module(channel).</input>
@@ -381,7 +381,7 @@ File generated from channel.erl by COVER 2001-05-21 at 11:16:38
Incidentally, when the test case is corrected a bug in <c>channel</c>
should indeed be discovered.</p>
<p>When the Cover analysis is ready, Cover is stopped and all Cover
- compiled modules are <seealso marker="#loading">unloaded</seealso>.
+ compiled modules are <seeguide marker="#loading">unloaded</seeguide>.
The code for <c>channel</c> is now loaded as usual from a
<c>.beam</c> file in the current path.</p>
<pre>
@@ -405,10 +405,10 @@ ok
Cover compiled module, performance decreases proportionally to
the size and number of the Cover compiled modules.</p>
<p>To improve performance when analysing cover results it is possible
- to do multiple calls to <seealso marker="cover#analyse/1">analyse</seealso>
- and <seealso marker="cover#analyse_to_file/1">analyse_to_file</seealso>
+ to do multiple calls to <seemfa marker="cover#analyse/1">analyse</seemfa>
+ and <seemfa marker="cover#analyse_to_file/1">analyse_to_file</seemfa>
at once. You can also use the
- <seealso marker="cover#async_analyse_to_file/1">async_analyse_to_file</seealso>
+ <seemfa marker="cover#async_analyse_to_file/1">async_analyse_to_file</seemfa>
convenience function.
</p>
</section>
diff --git a/lib/tools/doc/src/cprof.xml b/lib/tools/doc/src/cprof.xml
index 079a64f181..03675b3e49 100644
--- a/lib/tools/doc/src/cprof.xml
+++ b/lib/tools/doc/src/cprof.xml
@@ -131,7 +131,7 @@
<c>(pause({'_','_','_'})+stop({on_load}))</c>.
</p>
<p>See also
- <seealso marker="#pause">pause/1..3</seealso> below.
+ <seeerl marker="#pause">pause/1..3</seeerl> below.
<marker id="pause"></marker>
</p>
</desc>
@@ -206,7 +206,7 @@
<c>(start({'_','_','_'})+start({on_load}))</c>.
</p>
<p>See also
- <seealso marker="#start">start/1..3</seealso> below.
+ <seeerl marker="#start">start/1..3</seeerl> below.
<marker id="start"></marker>
</p>
</desc>
@@ -249,7 +249,7 @@
<c>(stop({'_','_','_'})+stop({on_load}))</c>.
</p>
<p>See also
- <seealso marker="#stop">stop/1..3</seealso> below.
+ <seeerl marker="#stop">stop/1..3</seeerl> below.
<marker id="stop"></marker>
</p>
</desc>
@@ -286,10 +286,10 @@
<section>
<title>See Also</title>
- <p><seealso marker="eprof">eprof</seealso>(3),
- <seealso marker="fprof">fprof</seealso>(3),
+ <p><seeerl marker="eprof">eprof</seeerl>(3),
+ <seeerl marker="fprof">fprof</seeerl>(3),
erlang(3),
- <seealso marker="cprof_chapter">User's Guide</seealso></p>
+ <seeguide marker="cprof_chapter">User's Guide</seeguide></p>
</section>
</erlref>
diff --git a/lib/tools/doc/src/cprof_chapter.xml b/lib/tools/doc/src/cprof_chapter.xml
index ba1e7432fd..2453f67ec5 100644
--- a/lib/tools/doc/src/cprof_chapter.xml
+++ b/lib/tools/doc/src/cprof_chapter.xml
@@ -88,7 +88,7 @@
</p>
<p>The following sections show some examples of profiling with
<c>cprof</c>. See also
- <seealso marker="cprof">cprof(3)</seealso>.
+ <seeerl marker="cprof">cprof(3)</seeerl>.
</p>
<section>
diff --git a/lib/tools/doc/src/erlang_mode.xml b/lib/tools/doc/src/erlang_mode.xml
index 7fef74813b..e22d4399a3 100644
--- a/lib/tools/doc/src/erlang_mode.xml
+++ b/lib/tools/doc/src/erlang_mode.xml
@@ -200,7 +200,7 @@
<section>
<title>Tags</title>
<p>For the tag commands to work it requires that you have
- generated a tag file. See <seealso marker="erlang_mode_chapter#tags">Erlang mode users guide</seealso></p>
+ generated a tag file. See <seeguide marker="erlang_mode_chapter#tags">Erlang mode users guide</seeguide></p>
<p></p>
<list type="bulleted">
<item><em><c>M-. </c></em> (<c>find-tag</c>) -
diff --git a/lib/tools/doc/src/fprof.xml b/lib/tools/doc/src/fprof.xml
index 4bb8862016..5d2683846f 100644
--- a/lib/tools/doc/src/fprof.xml
+++ b/lib/tools/doc/src/fprof.xml
@@ -558,7 +558,7 @@
<item>Specifies if the analysis should be sorted according
to the ACC column, which is the default, or the OWN
column. See
- <seealso marker="#analysis">Analysis Format</seealso> below.</item>
+ <seeerl marker="#analysis">Analysis Format</seeerl> below.</item>
<tag><c>totals</c>| <c>{totals, true}</c></tag>
<item>Includes a section containing call statistics
for all calls regardless of process, in the analysis.</item>
@@ -580,7 +580,7 @@
<marker id="analysis"></marker>
<title>Analysis format</title>
<p>This section describes the output format of the analyse
- command. See <seealso marker="#analyse">analyse/0</seealso>.
+ command. See <seeerl marker="#analyse">analyse/0</seeerl>.
</p>
<p>The format is parsable with the standard Erlang parsing tools
<c>erl_scan</c> and <c>erl_parse</c>, <c>file:consult/1</c> or
@@ -910,9 +910,9 @@ create_file_slow(FD, M, N) ->
<section>
<title>See Also</title>
- <p>dbg(3), <seealso marker="eprof">eprof</seealso>(3), erlang(3),
+ <p>dbg(3), <seeerl marker="eprof">eprof</seeerl>(3), erlang(3),
io(3),
- <seealso marker="fprof_chapter">Tools User's Guide</seealso></p>
+ <seeguide marker="fprof_chapter">Tools User's Guide</seeguide></p>
</section>
</erlref>
diff --git a/lib/tools/doc/src/fprof_chapter.xml b/lib/tools/doc/src/fprof_chapter.xml
index 5a2a5ad47c..5d161ed2e6 100644
--- a/lib/tools/doc/src/fprof_chapter.xml
+++ b/lib/tools/doc/src/fprof_chapter.xml
@@ -72,7 +72,7 @@
</p>
<p>The following sections show some examples of how to profile with
Fprof. See also the reference manual
- <seealso marker="fprof">fprof(3)</seealso>.
+ <seeerl marker="fprof">fprof(3)</seeerl>.
</p>
<section>
@@ -95,12 +95,12 @@
<c>fprof:analyse([{dest, "my_fprof.analysis"}, {cols, 120}])</c>
for a wider listing on non-default filename.
</p>
- <p>See the <seealso marker="fprof">fprof(3)</seealso> manual page
+ <p>See the <seeerl marker="fprof">fprof(3)</seeerl> manual page
for more options and arguments to the functions
- <seealso marker="fprof#trace">trace</seealso>,
- <seealso marker="fprof#profile">profile</seealso>
+ <seeerl marker="fprof#trace">trace</seeerl>,
+ <seeerl marker="fprof#profile">profile</seeerl>
and
- <seealso marker="fprof#analyse">analyse</seealso>.
+ <seeerl marker="fprof#analyse">analyse</seeerl>.
</p>
</section>
diff --git a/lib/tools/doc/src/instrument.xml b/lib/tools/doc/src/instrument.xml
index 7286e5c1cc..a6402b0643 100644
--- a/lib/tools/doc/src/instrument.xml
+++ b/lib/tools/doc/src/instrument.xml
@@ -94,7 +94,7 @@
<fsummary>Return a summary of all allocations in the system.</fsummary>
<desc>
<p>Shorthand for
- <seealso marker="#allocations/1"><c>allocations(#{})</c>.</seealso></p>
+ <seemfa marker="#allocations/1"><c>allocations(#{})</c>.</seemfa></p>
</desc>
</func>
@@ -107,8 +107,8 @@
optionally filtered by allocator type and scheduler id.</p>
<p>Only binaries and allocations made by NIFs and drivers are tagged by
default, but this can be configured an a per-allocator basis with the
- <seealso marker="erts:erts_alloc#M_atags"><c>+M&lt;S&gt;atags</c>
- </seealso> emulator option.</p>
+ <seecref marker="erts:erts_alloc#M_atags"><c>+M&lt;S&gt;atags</c>
+ </seecref> emulator option.</p>
<p>If the specified allocator types are not enabled, the call will fail
with <c>{error, not_enabled}</c>.</p>
<p>The following options can be used:</p>
@@ -175,7 +175,7 @@
<fsummary>Return a list of all carriers in the system.</fsummary>
<desc>
<p>Shorthand for
- <seealso marker="#carriers/1"><c>carriers(#{})</c>.</seealso></p>
+ <seemfa marker="#carriers/1"><c>carriers(#{})</c>.</seemfa></p>
</desc>
</func>
@@ -230,8 +230,8 @@
<section>
<title>See Also</title>
- <p><seealso marker="erts:erts_alloc">erts_alloc(3)</seealso>,
- <seealso marker="erts:erl">erl(1)</seealso></p>
+ <p><seecref marker="erts:erts_alloc">erts_alloc(3)</seecref>,
+ <seecom marker="erts:erl">erl(1)</seecom></p>
</section>
</erlref>
diff --git a/lib/tools/doc/src/lcnt.xml b/lib/tools/doc/src/lcnt.xml
index 1d434decfc..b2442628d5 100644
--- a/lib/tools/doc/src/lcnt.xml
+++ b/lib/tools/doc/src/lcnt.xml
@@ -149,7 +149,7 @@
</type>
<desc>
<p>Prints a list of internal locks and its statistics.</p>
- <p>For option description, see <seealso marker="#inspect/2">lcnt:inspect/2</seealso>.</p>
+ <p>For option description, see <seemfa marker="#inspect/2">lcnt:inspect/2</seemfa>.</p>
</desc>
</func>
@@ -172,7 +172,7 @@
</type>
<desc>
<p>Prints a list of internal lock counters by source code locations.</p>
- <p>For option description, see <seealso marker="#inspect/2">lcnt:inspect/2</seealso>.</p>
+ <p>For option description, see <seemfa marker="#inspect/2">lcnt:inspect/2</seemfa>.</p>
</desc>
</func>
@@ -196,7 +196,7 @@
</type>
<desc>
<p>Prints a list of internal lock counters for a specific lock.</p>
- <p>Lock <c>Name</c> and <c>Id</c> for ports and processes are interchangeable with the use of <c>lcnt:swap_pid_keys/0</c> and is the reason why <c>pid()</c> and <c>port()</c> options can be used in both <c>Name</c> and <c>Id</c> space. Both pids and ports are special identifiers with stripped creation and can be recreated with <seealso marker="#pid/3">lcnt:pid/2,3</seealso> and <seealso marker="#port/2">lcnt:port/1,2</seealso>. </p>
+ <p>Lock <c>Name</c> and <c>Id</c> for ports and processes are interchangeable with the use of <c>lcnt:swap_pid_keys/0</c> and is the reason why <c>pid()</c> and <c>port()</c> options can be used in both <c>Name</c> and <c>Id</c> space. Both pids and ports are special identifiers with stripped creation and can be recreated with <seemfa marker="#pid/3">lcnt:pid/2,3</seemfa> and <seemfa marker="#port/2">lcnt:port/1,2</seemfa>. </p>
<p>Option description:</p>
<taglist>
<tag><c>{combine, bool()}</c></tag>
@@ -529,6 +529,6 @@
<section>
<title>See Also</title>
- <p> <seealso marker="lcnt_chapter">LCNT User's Guide</seealso></p>
+ <p> <seeguide marker="lcnt_chapter">LCNT User's Guide</seeguide></p>
</section>
</erlref>
diff --git a/lib/tools/doc/src/lcnt_chapter.xml b/lib/tools/doc/src/lcnt_chapter.xml
index 24b58136aa..d0197fdc4b 100644
--- a/lib/tools/doc/src/lcnt_chapter.xml
+++ b/lib/tools/doc/src/lcnt_chapter.xml
@@ -70,7 +70,7 @@ Erlang/OTP 20 [erts-9.0] [64-bit] [smp:8:8] [ds:8:8:10] [async-threads:10] [hipe
<p>To retrieve lock statistics information, use <c>lcnt:collect/0,1</c>. The collect operation will start a <c>lcnt</c> server if it not already started. All collected data will be built into an Erlang term and uploaded to the server and a duration time will also be uploaded. This duration is the time between <c>lcnt:clear/0,1</c> and <c>lcnt:collect/0,1</c>.</p>
<p>Once the data is collected to the server it can be filtered, sorted and printed in many different ways.</p>
- <p>See the <seealso marker="lcnt">reference manual</seealso> for a description of each function.</p>
+ <p>See the <seeerl marker="lcnt">reference manual</seeerl> for a description of each function.</p>
</section>
<section>
<title> Example of usage </title>
@@ -290,6 +290,6 @@ ok
<section>
<title>See Also</title>
- <p> <seealso marker="lcnt">LCNT Reference Manual</seealso></p>
+ <p> <seeerl marker="lcnt">LCNT Reference Manual</seeerl></p>
</section>
</chapter>
diff --git a/lib/tools/doc/src/make.xml b/lib/tools/doc/src/make.xml
index 7f19938c45..4c66fecaf1 100644
--- a/lib/tools/doc/src/make.xml
+++ b/lib/tools/doc/src/make.xml
@@ -148,7 +148,7 @@ Modules.
<section>
<title>See Also</title>
- <p><seealso marker="compiler:compile"><c>compile(3)</c></seealso></p>
+ <p><seeerl marker="compiler:compile"><c>compile(3)</c></seeerl></p>
</section>
</erlref>
diff --git a/lib/tools/doc/src/notes.xml b/lib/tools/doc/src/notes.xml
index 01314cf953..728343a86f 100644
--- a/lib/tools/doc/src/notes.xml
+++ b/lib/tools/doc/src/notes.xml
@@ -56,9 +56,9 @@
</item>
<item>
<p>
- Fixed generated <seealso
+ Fixed generated <seeerl
marker="tools:fprof#analysis">fprof analysis
- format</seealso> to also handle data in maps.</p>
+ format</seeerl> to also handle data in maps.</p>
<p>
Own Id: OTP-16498 Aux Id: ERL-814 </p>
</item>
@@ -720,10 +720,10 @@
Earlier, supervisor flags and child specs were given as
tuples. While this is kept for backwards compatibility,
it is now also allowed to give these parameters as maps,
- see <seealso
- marker="stdlib:supervisor#sup_flags">sup_flags</seealso>
- and <seealso
- marker="stdlib:supervisor#child_spec">child_spec</seealso>.</p>
+ see <seeerl
+ marker="stdlib:supervisor#sup_flags">sup_flags</seeerl>
+ and <seeerl
+ marker="stdlib:supervisor#child_spec">child_spec</seeerl>.</p>
<p>
Own Id: OTP-11043</p>
</item>
diff --git a/lib/tools/doc/src/xref.xml b/lib/tools/doc/src/xref.xml
index 5f2d50600b..33b8003320 100644
--- a/lib/tools/doc/src/xref.xml
+++ b/lib/tools/doc/src/xref.xml
@@ -125,7 +125,7 @@ debug information, which is an abstract
is not exported by any analyzed module or library module. With
this notion, a local function can be an undefined function, namely
if it is externally used from some module. All unknown functions
- are also undefined functions; there is a <seealso marker="xref_chapter#venn2">figure</seealso> in the
+ are also undefined functions; there is a <seeguide marker="xref_chapter#venn2">figure</seeguide> in the
User's Guide that illustrates this relationship.
</p>
<p>Starting with R9C, the module attribute tag <c>deprecated</c>
@@ -743,8 +743,8 @@ xref() = atom() | pid() </pre>
<v>Xref = xref()</v>
</type>
<desc>
- <p>Adds an application, the modules of the application and <seealso marker="#module_data">module data</seealso> of the
- modules to an <seealso marker="#xref_server">Xref server</seealso>.
+ <p>Adds an application, the modules of the application and <seeerl marker="#module_data">module data</seeerl> of the
+ modules to an <seeerl marker="#xref_server">Xref server</seeerl>.
The modules will be members of the application.
The default is to use the base name of the
directory with the version removed as application name, but
@@ -756,9 +756,9 @@ xref() = atom() | pid() </pre>
directory, otherwise modules are searched for in the given
directory.
</p>
- <p>If the <seealso marker="#mode">mode</seealso> of the Xref
+ <p>If the <seeerl marker="#mode">mode</seeerl> of the Xref
server is <c>functions</c>, BEAM files that contain no
- <seealso marker="#debug_info">debug information</seealso> are
+ <seeerl marker="#debug_info">debug information</seeerl> are
ignored.
</p>
</desc>
@@ -776,8 +776,8 @@ xref() = atom() | pid() </pre>
<v>Xref = xref()</v>
</type>
<desc>
- <p>Adds the modules found in the given directory and the <seealso marker="#module_data">modules' data</seealso>
- to an <seealso marker="#xref_server">Xref server</seealso>.
+ <p>Adds the modules found in the given directory and the <seeerl marker="#module_data">modules' data</seeerl>
+ to an <seeerl marker="#xref_server">Xref server</seeerl>.
The default is not to examine subdirectories, but if the option
<c>recurse</c> has the value <c>true</c>, modules are searched
for in subdirectories on all levels as well as in the given
@@ -786,9 +786,9 @@ xref() = atom() | pid() </pre>
</p>
<p>The modules added will not be members of any applications.
</p>
- <p>If the <seealso marker="#mode">mode</seealso> of the Xref
+ <p>If the <seeerl marker="#mode">mode</seeerl> of the Xref
server is <c>functions</c>, BEAM files that contain no
- <seealso marker="#debug_info">debug information</seealso> are
+ <seeerl marker="#debug_info">debug information</seeerl> are
ignored.
</p>
</desc>
@@ -805,13 +805,13 @@ xref() = atom() | pid() </pre>
<v>Xref = xref()</v>
</type>
<desc>
- <p>Adds a module and its <seealso marker="#module_data">module data</seealso> to an <seealso marker="#xref_server">Xref server</seealso>.
+ <p>Adds a module and its <seeerl marker="#module_data">module data</seeerl> to an <seeerl marker="#xref_server">Xref server</seeerl>.
The module will not be member of any application.
Returns the name of the module.
</p>
- <p>If the <seealso marker="#mode">mode</seealso> of the Xref
+ <p>If the <seeerl marker="#mode">mode</seeerl> of the Xref
server is <c>functions</c>, and the BEAM file contains no
- <seealso marker="#debug_info">debug information</seealso>,
+ <seeerl marker="#debug_info">debug information</seeerl>,
the error message <c>no_debug_info</c> is returned.
</p>
</desc>
@@ -829,8 +829,8 @@ xref() = atom() | pid() </pre>
</type>
<desc>
<p>Adds a release, the applications of the release, the
- modules of the applications, and <seealso marker="#module_data">module data</seealso> of the
- modules to an <seealso marker="#xref_server">Xref server</seealso>.
+ modules of the applications, and <seeerl marker="#module_data">module data</seeerl> of the
+ modules to an <seeerl marker="#xref_server">Xref server</seeerl>.
The applications will be members of the release,
and the modules will be members of the applications.
The default is to use the base name of the
@@ -844,9 +844,9 @@ xref() = atom() | pid() </pre>
If there are several versions of some application, the one
with the highest version is chosen.
</p>
- <p>If the <seealso marker="#mode">mode</seealso> of the Xref
+ <p>If the <seeerl marker="#mode">mode</seeerl> of the Xref
server is <c>functions</c>, BEAM files that contain no
- <seealso marker="#debug_info">debug information</seealso> are
+ <seeerl marker="#debug_info">debug information</seeerl> are
ignored.
</p>
</desc>
@@ -873,13 +873,13 @@ xref() = atom() | pid() </pre>
Evaluates a predefined analysis.
Returns a sorted list without duplicates of <c>call()</c> or
<c>constant()</c>, depending on the chosen analysis. The
- predefined analyses, which operate on all <seealso marker="#analyzed_module">analyzed modules</seealso>, are
- (analyses marked with (*) are available in <c>functions</c><seealso marker="#mode">mode</seealso> only):</p>
+ predefined analyses, which operate on all <seeerl marker="#analyzed_module">analyzed modules</seeerl>, are
+ (analyses marked with (*) are available in <c>functions</c><seeerl marker="#mode">mode</seeerl> only):</p>
<taglist>
<tag><c>undefined_function_calls</c>(*)</tag>
- <item>Returns a list of calls to <seealso marker="#undefined_function">undefined functions</seealso>.</item>
+ <item>Returns a list of calls to <seeerl marker="#undefined_function">undefined functions</seeerl>.</item>
<tag><c>undefined_functions</c></tag>
- <item>Returns a list of <seealso marker="#undefined_function">undefined functions</seealso>. </item>
+ <item>Returns a list of <seeerl marker="#undefined_function">undefined functions</seeerl>. </item>
<tag><c>locals_not_used</c>(*)</tag>
<item>Returns a list of local functions that have not been
locally used.</item>
@@ -887,7 +887,7 @@ Evaluates a predefined analysis.
<item>Returns a list of exported functions that have not been
externally used.</item>
<tag><c>deprecated_function_calls</c>(*)</tag>
- <item>Returns a list of external calls to <seealso marker="#deprecated_function">deprecated functions</seealso>.</item>
+ <item>Returns a list of external calls to <seeerl marker="#deprecated_function">deprecated functions</seeerl>.</item>
<tag><c>{deprecated_function_calls, DeprFlag}</c>(*)</tag>
<item>Returns a list of external calls to deprecated
functions. If <c>DeprFlag</c> is equal to
@@ -953,11 +953,11 @@ Evaluates a predefined analysis.
</type>
<desc>
<p>The modules found in the given directory are checked for
- calls to <seealso marker="#deprecated_function">deprecated functions</seealso>, calls to <seealso marker="#undefined_function">undefined functions</seealso>,
+ calls to <seeerl marker="#deprecated_function">deprecated functions</seeerl>, calls to <seeerl marker="#undefined_function">undefined functions</seeerl>,
and for unused local functions. The code path is used as
- <seealso marker="#library_path">library path</seealso>.
+ <seeerl marker="#library_path">library path</seeerl>.
</p>
- <p>If some of the found BEAM files contain <seealso marker="#debug_info">debug information</seealso>, then those
+ <p>If some of the found BEAM files contain <seeerl marker="#debug_info">debug information</seeerl>, then those
modules are checked and a list of tuples is returned. The
first element of each tuple is one of:
</p>
@@ -993,7 +993,7 @@ Evaluates a predefined analysis.
</type>
<desc>
<p><c>forget/1</c> and <c>forget/2</c> remove all or some of
- the <seealso marker="#user_variable">user variables</seealso> of an <seealso marker="#xref_server">xref server</seealso>.</p>
+ the <seeerl marker="#user_variable">user variables</seeerl> of an <seeerl marker="#xref_server">xref server</seeerl>.</p>
</desc>
</func>
<func>
@@ -1033,7 +1033,7 @@ Evaluates a predefined analysis.
<v>Xref = xref()</v>
</type>
<desc>
- <p>Returns the <seealso marker="#library_path">library path</seealso>.</p>
+ <p>Returns the <seeerl marker="#library_path">library path</seeerl>.</p>
</desc>
</func>
<func>
@@ -1055,27 +1055,27 @@ Evaluates a predefined analysis.
<desc>
<p>The <c>info</c> functions return information as a list of
pairs {Tag,&nbsp;term()} in some order about the state and the
- <seealso marker="#module_data">module data</seealso> of an <seealso marker="#xref_server">Xref server</seealso>.
+ <seeerl marker="#module_data">module data</seeerl> of an <seeerl marker="#xref_server">Xref server</seeerl>.
</p>
<p><c>info/1</c> returns information with the following tags
(tags marked with (*) are available in <c>functions</c>
mode only):</p>
<list type="bulleted">
- <item><c>library_path</c>, the <seealso marker="#library_path">library path</seealso>;</item>
- <item><c>mode</c>, the <seealso marker="#mode">mode</seealso>;</item>
+ <item><c>library_path</c>, the <seeerl marker="#library_path">library path</seeerl>;</item>
+ <item><c>mode</c>, the <seeerl marker="#mode">mode</seeerl>;</item>
<item><c>no_releases</c>, number of releases;</item>
<item><c>no_applications</c>, total number of applications
(of all releases);</item>
- <item><c>no_analyzed_modules</c>, total number of <seealso marker="#analyzed_module">analyzed modules</seealso>;</item>
+ <item><c>no_analyzed_modules</c>, total number of <seeerl marker="#analyzed_module">analyzed modules</seeerl>;</item>
<item><c>no_calls</c> (*), total number of calls (in all
modules), regarding instances of one function call in
different lines as separate calls;</item>
- <item><c>no_function_calls</c> (*), total number of <seealso marker="#local_call">local calls</seealso>, resolved <seealso marker="#external_call">external calls</seealso> and
- <seealso marker="#unresolved_call">unresolved calls</seealso>;</item>
+ <item><c>no_function_calls</c> (*), total number of <seeerl marker="#local_call">local calls</seeerl>, resolved <seeerl marker="#external_call">external calls</seeerl> and
+ <seeerl marker="#unresolved_call">unresolved calls</seeerl>;</item>
<item><c>no_functions</c> (*), total number of local and exported
functions;</item>
<item><c>no_inter_function_calls</c> (*), total number of
- calls of the <seealso marker="#inter_call_graph">Inter Call Graph</seealso>.</item>
+ calls of the <seeerl marker="#inter_call_graph">Inter Call Graph</seeerl>.</item>
</list>
<p><c>info/2</c> and <c>info/3</c> return information about
all or some of the analyzed modules, applications, releases
@@ -1144,7 +1144,7 @@ Evaluates a predefined analysis.
</list>
<p>The following information is returned for every library module:</p>
<list type="bulleted">
- <item><c>directory</c>, the directory where the <seealso marker="#library_module">library module's</seealso> BEAM file is located.</item>
+ <item><c>directory</c>, the directory where the <seeerl marker="#library_module">library module's</seeerl> BEAM file is located.</item>
</list>
<p>For every number of calls, functions etc. returned by the
<c>no_</c> tags, there is a query returning the same number.
@@ -1237,11 +1237,11 @@ Evaluates a predefined analysis.
<desc>
<p>The given BEAM file (with or without the <c>.beam</c>
extension) or the file found by calling
- <c>code:which(Module)</c> is checked for calls to <seealso marker="#deprecated_function">deprecated functions</seealso>, calls to <seealso marker="#undefined_function">undefined functions</seealso>,
+ <c>code:which(Module)</c> is checked for calls to <seeerl marker="#deprecated_function">deprecated functions</seeerl>, calls to <seeerl marker="#undefined_function">undefined functions</seeerl>,
and for unused local functions. The code path is used as
- <seealso marker="#library_path">library path</seealso>.
+ <seeerl marker="#library_path">library path</seeerl>.
</p>
- <p>If the BEAM file contains <seealso marker="#debug_info">debug information</seealso>, then a
+ <p>If the BEAM file contains <seeerl marker="#debug_info">debug information</seeerl>, then a
list of tuples is returned. The first element of each tuple
is one of:
</p>
@@ -1286,8 +1286,8 @@ Evaluates a predefined analysis.
<v>Xref = xref()</v>
</type>
<desc>
- <p>Evaluates a <seealso marker="#query">query</seealso> in the
- context of an <seealso marker="#xref_server">Xref server</seealso>, and returns the value of the last
+ <p>Evaluates a <seeerl marker="#query">query</seeerl> in the
+ context of an <seeerl marker="#xref_server">Xref server</seeerl>, and returns the value of the last
statement. The syntax of the value depends on the
expression:
</p>
@@ -1334,7 +1334,7 @@ Evaluates a predefined analysis.
<v>Xref = xref()</v>
</type>
<desc>
- <p>Removes applications and their modules and <seealso marker="#module_data">module data</seealso> from an <seealso marker="#xref_server">Xref server</seealso>.</p>
+ <p>Removes applications and their modules and <seeerl marker="#module_data">module data</seeerl> from an <seeerl marker="#xref_server">Xref server</seeerl>.</p>
</desc>
</func>
<func>
@@ -1347,7 +1347,7 @@ Evaluates a predefined analysis.
<v>Xref = xref()</v>
</type>
<desc>
- <p>Removes <seealso marker="#analyzed_module">analyzed modules</seealso> and <seealso marker="#module_data">module data</seealso> from an <seealso marker="#xref_server">Xref server</seealso>.</p>
+ <p>Removes <seeerl marker="#analyzed_module">analyzed modules</seeerl> and <seeerl marker="#module_data">module data</seeerl> from an <seeerl marker="#xref_server">Xref server</seeerl>.</p>
</desc>
</func>
<func>
@@ -1361,8 +1361,8 @@ Evaluates a predefined analysis.
</type>
<desc>
<p>Removes releases and their applications, modules and
- <seealso marker="#module_data">module data</seealso> from an
- <seealso marker="#xref_server">Xref server</seealso>.</p>
+ <seeerl marker="#module_data">module data</seeerl> from an
+ <seeerl marker="#xref_server">Xref server</seeerl>.</p>
</desc>
</func>
<func>
@@ -1400,7 +1400,7 @@ Evaluates a predefined analysis.
<v>Xref = xref()</v>
</type>
<desc>
- <p>Replaces <seealso marker="#module_data">module data</seealso> of an <seealso marker="#analyzed_module">analyzed module</seealso> with
+ <p>Replaces <seeerl marker="#module_data">module data</seeerl> of an <seeerl marker="#analyzed_module">analyzed module</seeerl> with
data read from a BEAM file. Application membership of the
module is retained, and so is the value of the
<c>builtins</c> option of the module. An error is returned
@@ -1433,7 +1433,7 @@ Evaluates a predefined analysis.
<item><c>verbose</c>, with initial default value <c>false</c>;</item>
<item><c>warnings</c>, with initial default value <c>true</c>.</item>
</list>
- <p>The initial default values are set when creating an <seealso marker="#xref_server">Xref server</seealso>.
+ <p>The initial default values are set when creating an <seeerl marker="#xref_server">Xref server</seeerl>.
</p>
</desc>
</func>
@@ -1449,8 +1449,8 @@ Evaluates a predefined analysis.
<v>Xref = xref()</v>
</type>
<desc>
- <p>Sets the <seealso marker="#library_path">library path</seealso>. If the given path is a list of
- directories, the set of <seealso marker="#library_module">library modules</seealso> is
+ <p>Sets the <seeerl marker="#library_path">library path</seeerl>. If the given path is a list of
+ directories, the set of <seeerl marker="#library_module">library modules</seeerl> is
determined by choosing the first module
encountered while traversing the directories in
the given order, for those modules that occur in more than
@@ -1461,7 +1461,7 @@ Evaluates a predefined analysis.
used by the functions
<c>m/1</c> and <c>d/1</c>, but can also be set explicitly.
Note however that the code path will be traversed once for
- each used <seealso marker="#library_module">library module</seealso> while setting up module data.
+ each used <seeerl marker="#library_module">library module</seeerl> while setting up module data.
On the other hand, if there are only a few modules that are
used but not analyzed, using <c>code_path</c> may be faster
than setting the library path to <c>code:get_path()</c>.
@@ -1482,9 +1482,9 @@ Evaluates a predefined analysis.
<v>Return = {ok, pid()} | {error, {already_started, pid()}}</v>
</type>
<desc>
- <p>Creates an <seealso marker="#xref_server">Xref server</seealso>.
+ <p>Creates an <seeerl marker="#xref_server">Xref server</seeerl>.
The process may optionally be given a name.
- The default <seealso marker="#mode">mode</seealso> is <c>functions</c>.
+ The default <seeerl marker="#mode">mode</seeerl> is <c>functions</c>.
Options that are not recognized by Xref
are passed on to <c>gen_server:start/4</c>.</p>
</desc>
@@ -1499,9 +1499,9 @@ Evaluates a predefined analysis.
<v>Return = {ok, pid()} | {error, {already_started, pid()}}</v>
</type>
<desc>
- <p>Creates an <seealso marker="#xref_server">Xref server</seealso>
+ <p>Creates an <seeerl marker="#xref_server">Xref server</seeerl>
with a given name.
- The default <seealso marker="#mode">mode</seealso> is <c>functions</c>.
+ The default <seeerl marker="#mode">mode</seeerl> is <c>functions</c>.
Options that are not recognized by Xref
are passed on to <c>gen_server:start/4</c>.</p>
</desc>
@@ -1513,7 +1513,7 @@ Evaluates a predefined analysis.
<v>Xref = xref()</v>
</type>
<desc>
- <p>Stops an <seealso marker="#xref_server">Xref server</seealso>.</p>
+ <p>Stops an <seeerl marker="#xref_server">Xref server</seeerl>.</p>
</desc>
</func>
<func>
@@ -1528,7 +1528,7 @@ Evaluates a predefined analysis.
<v>Xref = xref()</v>
</type>
<desc>
- <p>Replaces the <seealso marker="#module_data">module data</seealso> of all <seealso marker="#analyzed_module">analyzed modules</seealso> the BEAM
+ <p>Replaces the <seeerl marker="#module_data">module data</seeerl> of all <seeerl marker="#analyzed_module">analyzed modules</seeerl> the BEAM
files of which have been modified since last read by an
<c>add</c> function or <c>update</c>. Application membership
of the modules is retained, and so is the value of the
@@ -1548,19 +1548,19 @@ Evaluates a predefined analysis.
</type>
<desc>
<p>Returns a sorted lists of the names of the variables of an
- <seealso marker="#xref_server">Xref server</seealso>.
- The default is to return the <seealso marker="#user_variable">user variables</seealso> only.</p>
+ <seeerl marker="#xref_server">Xref server</seeerl>.
+ The default is to return the <seeerl marker="#user_variable">user variables</seeerl> only.</p>
</desc>
</func>
</funcs>
<section>
<title>See Also</title><p>
- <seealso marker="stdlib:beam_lib">beam_lib(3)</seealso>,
- <seealso marker="stdlib:digraph">digraph(3)</seealso>,
- <seealso marker="stdlib:digraph_utils">digraph_utils(3)</seealso>,
- <seealso marker="stdlib:re">re(3)</seealso>,
- <seealso marker="xref_chapter">TOOLS User's Guide</seealso></p>
+ <seeerl marker="stdlib:beam_lib">beam_lib(3)</seeerl>,
+ <seeerl marker="stdlib:digraph">digraph(3)</seeerl>,
+ <seeerl marker="stdlib:digraph_utils">digraph_utils(3)</seeerl>,
+ <seeerl marker="stdlib:re">re(3)</seeerl>,
+ <seeguide marker="xref_chapter">TOOLS User's Guide</seeguide></p>
</section>
</erlref>
diff --git a/lib/tools/doc/src/xref_chapter.xml b/lib/tools/doc/src/xref_chapter.xml
index 872793bdcb..d6d97150d9 100644
--- a/lib/tools/doc/src/xref_chapter.xml
+++ b/lib/tools/doc/src/xref_chapter.xml
@@ -49,7 +49,7 @@
with a module check and a predefined analysis. Then follow
examples that can be skipped on the first reading; not all of
the concepts used are explained, and it is assumed that the
- <seealso marker="xref">reference manual</seealso> has been at
+ <seeerl marker="xref">reference manual</seeerl> has been at
least skimmed.
</p>
@@ -78,7 +78,7 @@
contains debug information, which makes it possible to find
unused local functions.
</p>
- <p>The module can now be checked for calls to <seealso marker="xref#deprecated_function">deprecated functions</seealso>, calls to <seealso marker="xref#undefined_function">undefined functions</seealso>,
+ <p>The module can now be checked for calls to <seeerl marker="xref#deprecated_function">deprecated functions</seeerl>, calls to <seeerl marker="xref#undefined_function">undefined functions</seeerl>,
and for unused local functions:
</p>
<pre>
@@ -92,7 +92,7 @@
either case, the code path of the code server (see the module
<c>code</c>) is used for finding modules that export externally
called functions not exported by the checked module itself, so
- called <seealso marker="xref#library_module">library modules</seealso>.
+ called <seeerl marker="xref#library_module">library modules</seeerl>.
</p>
</section>
@@ -100,7 +100,7 @@
<title>Predefined Analysis</title>
<p>In the last example the module to analyze was given as an
argument to <c>m/1</c>, and the code path was (implicitly)
- used as <seealso marker="xref#library_path">library path</seealso>. In this example an <seealso marker="xref#xref_server">xref server</seealso> will be used,
+ used as <seeerl marker="xref#library_path">library path</seeerl>. In this example an <seeerl marker="xref#xref_server">xref server</seeerl> will be used,
which makes it possible to analyze applications and releases,
and also to select the library path explicitly.
</p>
@@ -115,7 +115,7 @@
Otherwise, when analyzing a system that uses OTP, the OTP
modules are typically made library modules by
setting the library path to the default OTP code path (or to
- <c>code_path</c>, see the <seealso marker="xref#code_path">reference manual</seealso>). By
+ <c>code_path</c>, see the <seeerl marker="xref#code_path">reference manual</seeerl>). By
default, the names of read BEAM files and warnings are output
when adding analyzed modules, but these messages can be avoided
by setting default values of some options:
@@ -145,12 +145,12 @@
predefined analysis, probably the most useful one. Other
examples are the analyses that find unused local
functions, or functions that call some given functions. See
- the <seealso marker="xref#analyze">analyze/2,3</seealso>
+ the <seeerl marker="xref#analyze">analyze/2,3</seeerl>
functions for a complete list of predefined analyses.
</p>
- <p>Each predefined analysis is a shorthand for a <seealso marker="xref#query">query</seealso>, a sentence of a tiny
+ <p>Each predefined analysis is a shorthand for a <seeerl marker="xref#query">query</seeerl>, a sentence of a tiny
language providing cross reference data as
- values of <seealso marker="xref#predefined_variable">predefined variables</seealso>.
+ values of <seeerl marker="xref#predefined_variable">predefined variables</seeerl>.
The check for calls to undefined functions can thus be stated as
a query:
</p>
@@ -173,7 +173,7 @@
<c>X&nbsp;+&nbsp;L&nbsp;+&nbsp;B&nbsp;+&nbsp;U</c>, and one
that focuses on how they are used:
<c>UU&nbsp;+&nbsp;LU&nbsp;+&nbsp;XU</c>.
- The reference also mentions some <seealso marker="xref#simple_facts">facts</seealso> about the
+ The reference also mentions some <seeerl marker="xref#simple_facts">facts</seeerl> about the
variables:
</p>
<list type="bulleted">
@@ -296,7 +296,7 @@
<section>
<title>Graph Analysis</title>
- <p>The list <seealso marker="xref#representation">representation of graphs</seealso> is used analyzing direct calls,
+ <p>The list <seeerl marker="xref#representation">representation of graphs</seeerl> is used analyzing direct calls,
while the <c>digraph</c> representation is suited for analyzing
indirect calls. The restriction operators (<c>|</c>, <c>||</c>
and <c>|||</c>) are the only operators that accept both
@@ -308,12 +308,12 @@
<p>As an example of analyzing indirect calls, the following Erlang
function tries to answer the question:
if we want to know which modules are used indirectly by some
- module(s), is it worth while using the <seealso marker="xref#call_graph">function graph</seealso> rather
+ module(s), is it worth while using the <seeerl marker="xref#call_graph">function graph</seeerl> rather
than the module graph? Recall that a module M1 is said to call
a module M2 if there is some function in M1 that calls some
function in M2. It would be nice if we could use the much
smaller module graph, since it is available also in the light
- weight <c>modules</c><seealso marker="xref#mode">mode</seealso> of Xref servers.
+ weight <c>modules</c><seeerl marker="xref#mode">mode</seeerl> of Xref servers.
</p>
<code type="erl">
t(S) ->