diff options
| author | Lukas Larsson <lukas@erlang.org> | 2020-03-11 10:11:22 +0100 |
|---|---|---|
| committer | Lukas Larsson <lukas@erlang.org> | 2020-03-27 11:02:23 +0100 |
| commit | 0799c2b0e9ae5fce18d092a153fff884d1dd3912 (patch) | |
| tree | c7c72465bd01591a9163e5ad17cea92bf3be75ec /lib/hipe/doc/src | |
| parent | 6c6fe8e774f7cde6d158b450fd1ad6c3129dc22e (diff) | |
| download | erlang-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/hipe/doc/src')
| -rw-r--r-- | lib/hipe/doc/src/HiPE_app.xml | 16 | ||||
| -rw-r--r-- | lib/hipe/doc/src/notes.xml | 10 |
2 files changed, 13 insertions, 13 deletions
diff --git a/lib/hipe/doc/src/HiPE_app.xml b/lib/hipe/doc/src/HiPE_app.xml index 2011edd03a..27fbf16fd0 100644 --- a/lib/hipe/doc/src/HiPE_app.xml +++ b/lib/hipe/doc/src/HiPE_app.xml @@ -72,8 +72,8 @@ </item> <tag>Stack traces</tag> - <item><p>Stack traces returned from <seealso marker="erts:erlang#get_stacktrace/0"> - <c>erlang:get_stacktrace/0</c></seealso> or as part of <c>'EXIT'</c> terms + <item><p>Stack traces returned from <seemfa marker="erts:erlang#get_stacktrace/0"> + <c>erlang:get_stacktrace/0</c></seemfa> or as part of <c>'EXIT'</c> terms can look incomplete if HiPE compiled functions are involved. Typically a stack trace will contain only BEAM compiled functions or only HiPE compiled functions, depending on where the exception was raised.</p> @@ -82,18 +82,18 @@ <tag>Tracing</tag> <item><p>Erlang call trace is not supported by HiPE. Calling - <seealso marker="erts:erlang#trace_pattern/3"><c>erlang:trace_pattern({M,F,A}, ...)</c></seealso> + <seemfa marker="erts:erlang#trace_pattern/3"><c>erlang:trace_pattern({M,F,A}, ...)</c></seemfa> does not have any effect on HiPE compiled modules.</p> </item> <tag>NIFs</tag> - <item><p>Modules compiled with HiPE cannot call <seealso marker="erts:erlang#load_nif/2"> - <c>erlang:load_nif/2</c></seealso> to load NIFs.</p> + <item><p>Modules compiled with HiPE cannot call <seemfa marker="erts:erlang#load_nif/2"> + <c>erlang:load_nif/2</c></seemfa> to load NIFs.</p> </item> <tag>-on_load</tag> <item><p>Modules compiled with HiPE cannot use - <seealso marker="doc/reference_manual:code_loading#on_load"><c>-on_load()</c></seealso> + <seeguide marker="system/reference_manual:code_loading#on_load"><c>-on_load()</c></seeguide> directives.</p> </item> </taglist> @@ -190,8 +190,8 @@ <section> <title>SEE ALSO</title> <p> - <seealso marker="stdlib:c">c(3)</seealso>, - <seealso marker="compiler:compile">compile(3)</seealso> + <seeerl marker="stdlib:c">c(3)</seeerl>, + <seeerl marker="compiler:compile">compile(3)</seeerl> </p> </section> diff --git a/lib/hipe/doc/src/notes.xml b/lib/hipe/doc/src/notes.xml index 8e1f5b35cd..f13551db83 100644 --- a/lib/hipe/doc/src/notes.xml +++ b/lib/hipe/doc/src/notes.xml @@ -381,9 +381,9 @@ Own Id: OTP-13810 Aux Id: PR-1124 </p> </item> <item> - <p>Replaced usage of deprecated symbolic <seealso - marker="erts:erlang#type-time_unit"><c>time - unit</c></seealso> representations.</p> + <p>Replaced usage of deprecated symbolic <seetype + marker="erts:erlang#time_unit"><c>time + unit</c></seetype> representations.</p> <p> Own Id: OTP-13831 Aux Id: OTP-13735 </p> </item> @@ -974,8 +974,8 @@ </taglist> <p> For information on how to use Maps please see Map Expressions in the - <seealso marker="doc/reference_manual:expressions#map_expressions"> - Reference Manual</seealso>.</p> + <seeguide marker="system/reference_manual:expressions#map_expressions"> + Reference Manual</seeguide>.</p> <p> The current implementation is without the following features:</p> |