erts: Move all functions in docs to be in alphabetical order

This commit only changes the order of functions and does some
other rearrangements to that the diff with the next commit will
be easier to follow. No content or XML tags are changed.

1 files changed, 132 insertions, 131 deletions

diff --git a/erts/doc/src/erl_tracer.xml b/erts/doc/src/erl_tracer.xml
index 7841fdfd63..e2852ce49d 100644
--- a/erts/doc/src/erl_tracer.xml
+++ b/erts/doc/src/erl_tracer.xml
@@ -169,83 +169,38 @@
         is important that it is both fast and side effect free.</p>
       </desc>
     </func>
-    <func>
-      <name>Module:trace(TraceTag, TracerState, Tracee, TraceTerm, Opts) -> Result</name>
-      <fsummary>Check if a trace event should be generated.</fsummary>
-      <type>
-        <v>TraceTag = <seealso marker="#type-trace_tag">trace_tag()</seealso></v>
-        <v>TracerState = term()</v>
-        <v>Tracee = <seealso marker="#type-tracee">tracee()</seealso></v>
-        <v>FirstTraceTerm = term()</v>
-        <v>Opts = <seealso marker="#type-trace_opts">trace_opts()</seealso></v>
-        <v>Result =  ok</v>
-      </type>
-      <desc>
-        <p>This callback will be called when a tracepoint is triggered and
-        the <seealso marker="#Module:enabled/3">Module:enabled/3</seealso>
-        callback returned <c>trace</c>. In it any side effects needed by
-        the tracer should be done. The tracepoint payload is located in
-        the <c>TraceTerm</c>. The content of the TraceTerm depends on which
-        <c>TraceTag</c> has been triggered.
-        The <c>TraceTerm</c> corresponds to the
-        fourth element in the trace tuples described in
-        <seealso marker="erlang#trace_3_trace_messages">erlang:trace/3</seealso>.
-        If the trace tuple has five elements, the fifth element will be sent as
-        the <c>extra</c> value in the <c>Opts</c> maps.</p>
-      </desc>
-    </func>
-    <func>
-      <name name="trace">Module:trace(seq_trace, TracerState, Label, SeqTraceInfo, Opts) -> Result</name>
-      <fsummary>Check if a sequence trace event should be generated.</fsummary>
-      <type>
-        <v>TracerState = term()</v>
-        <v>Label = term()</v>
-        <v>SeqTraceInfo = term()</v>
-        <v>Opts = <seealso marker="#type-trace_opts">trace_opts()</seealso></v>
-        <v>Result =  ok</v>
-      </type>
-      <desc>
-        <p>The <c>TraceTag</c> <c>seq_trace</c> is handled a little bit
-        differently. There is not <c>Tracee</c> for seq_trace, instead the
-        <c>Label</c> associated with the seq_trace event is given.
-        For more info on what <c>Label</c> and <c>SeqTraceInfo</c> can be
-        see the <seealso marker="kernel:seq_trace">seq_trace</seealso> manual.</p>
-      </desc>
-    </func>
 
     <func>
-        <name>Module:enabled_procs(TraceTag, TracerState, Tracee) -> Result</name>
+        <name>Module:enabled_call(TraceTag, TracerState, Tracee) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
         <type>
-            <v>TraceTag = <seealso marker="#type-trace_tag_procs">trace_tag_procs()</seealso></v>
+            <v>TraceTag = <seealso marker="#type-trace_tag_call">trace_tag_call()</seealso></v>
             <v>TracerState = term()</v>
             <v>Tracee = <seealso marker="#type-tracee">tracee()</seealso></v>
             <v>Result = trace | discard | remove</v>
         </type>
         <desc>
             <p>This callback will be called whenever a tracepoint with trace flag
-                <seealso marker="erlang#trace-3"><c>procs</c></seealso>
+                <seealso marker="erlang#trace-3"><c>call | return_to</c></seealso>
                 is triggered.</p>
-            <p>If <c>enabled_procs/3</c> is not defined <c>enabled/3</c> will be called instead.</p>
+            <p>If <c>enabled_call/3</c> is not defined <c>enabled/3</c> will be called instead.</p>
         </desc>
     </func>
 
     <func>
-        <name>Module:trace_procs(TraceTag, TracerState, Tracee, TraceTerm, Opts) -> Result</name>
+        <name>Module:enabled_garbage_collection(TraceTag, TracerState, Tracee) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
         <type>
-            <v>TraceTag = <seealso marker="#type-trace_tag_procs">trace_tag()</seealso></v>
+            <v>TraceTag = <seealso marker="#type-trace_tag_gc">trace_tag_gc()</seealso></v>
             <v>TracerState = term()</v>
             <v>Tracee = <seealso marker="#type-tracee">tracee()</seealso></v>
-            <v>FirstTraceTerm = term()</v>
-            <v>Opts = <seealso marker="#type-trace_opts">trace_opts()</seealso></v>
-            <v>Result = ok</v>
+            <v>Result = trace | discard | remove</v>
         </type>
         <desc>
-            <p>This callback will be called when a tracepoint is triggered and
-                the <seealso marker="#Module:enabled_procs/3">Module:enabled_procs/3</seealso>
-                callback returned <c>trace</c>.</p>
-            <p>If <c>trace_procs/5</c> is not defined <c>trace/5</c> will be called instead.</p>
+            <p>This callback will be called whenever a tracepoint with trace flag
+                <seealso marker="erlang#trace-3"><c>garbage_collection</c></seealso>
+                is triggered.</p>
+            <p>If <c>enabled_garbage_collection/3</c> is not defined <c>enabled/3</c> will be called instead.</p>
         </desc>
     </func>
 
@@ -267,57 +222,36 @@
     </func>
 
     <func>
-        <name>Module:trace_ports(TraceTag, TracerState, Tracee, TraceTerm, Opts) -> Result</name>
-        <fsummary>Check if a trace event should be generated.</fsummary>
-        <type>
-            <v>TraceTag = <seealso marker="#type-trace_tag_ports">trace_tag()</seealso></v>
-            <v>TracerState = term()</v>
-            <v>Tracee = <seealso marker="#type-tracee">tracee()</seealso></v>
-            <v>FirstTraceTerm = term()</v>
-            <v>Opts = <seealso marker="#type-trace_opts">trace_opts()</seealso></v>
-            <v>Result = ok</v>
-        </type>
-        <desc>
-            <p>This callback will be called when a tracepoint is triggered and
-                the <seealso marker="#Module:enabled_ports/3">Module:enabled_ports/3</seealso>
-                callback returned <c>trace</c>.</p>
-            <p>If <c>trace_ports/5</c> is not defined <c>trace/5</c> will be called instead.</p>
-        </desc>
-    </func>
-
-    <func>
-        <name>Module:enabled_running_procs(TraceTag, TracerState, Tracee) -> Result</name>
+        <name>Module:enabled_procs(TraceTag, TracerState, Tracee) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
         <type>
-            <v>TraceTag = <seealso marker="#type-trace_tag_running_procs">trace_tag_running_procs()</seealso></v>
+            <v>TraceTag = <seealso marker="#type-trace_tag_procs">trace_tag_procs()</seealso></v>
             <v>TracerState = term()</v>
             <v>Tracee = <seealso marker="#type-tracee">tracee()</seealso></v>
             <v>Result = trace | discard | remove</v>
         </type>
         <desc>
             <p>This callback will be called whenever a tracepoint with trace flag
-                <seealso marker="erlang#trace-3"><c>running_procs | running</c></seealso>
+                <seealso marker="erlang#trace-3"><c>procs</c></seealso>
                 is triggered.</p>
-            <p>If <c>enabled_running_procs/3</c> is not defined <c>enabled/3</c> will be called instead.</p>
+            <p>If <c>enabled_procs/3</c> is not defined <c>enabled/3</c> will be called instead.</p>
         </desc>
     </func>
 
     <func>
-        <name>Module:trace_running_procs(TraceTag, TracerState, Tracee, TraceTerm, Opts) -> Result</name>
+        <name>Module:enabled_receive(TraceTag, TracerState, Tracee) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
         <type>
-            <v>TraceTag = <seealso marker="#type-trace_tag_running_procs">trace_tag_running_procs()</seealso></v>
+            <v>TraceTag = <seealso marker="#type-trace_tag_receive">trace_tag_receive()</seealso></v>
             <v>TracerState = term()</v>
             <v>Tracee = <seealso marker="#type-tracee">tracee()</seealso></v>
-            <v>FirstTraceTerm = term()</v>
-            <v>Opts = <seealso marker="#type-trace_opts">trace_opts()</seealso></v>
-            <v>Result = ok</v>
+            <v>Result = trace | discard | remove</v>
         </type>
         <desc>
-            <p>This callback will be called when a tracepoint is triggered and
-                the <seealso marker="#Module:enabled_running_procs/3">Module:enabled_running_procs/3</seealso>
-                callback returned <c>trace</c>.</p>
-            <p>If <c>trace_running_procs/5</c> is not defined <c>trace/5</c> will be called instead.</p>
+            <p>This callback will be called whenever a tracepoint with trace flag
+                <seealso marker="erlang#trace-3"><c>'receive'</c></seealso>
+                is triggered.</p>
+            <p>If <c>enabled_receive/3</c> is not defined <c>enabled/3</c> will be called instead.</p>
         </desc>
     </func>
 
@@ -339,42 +273,84 @@
     </func>
 
     <func>
-        <name>Module:trace_running_ports(TraceTag, TracerState, Tracee, TraceTerm, Opts) -> Result</name>
+        <name>Module:enabled_running_procs(TraceTag, TracerState, Tracee) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
         <type>
-            <v>TraceTag = <seealso marker="#type-trace_tag_running_ports">trace_tag_running_ports()</seealso></v>
+            <v>TraceTag = <seealso marker="#type-trace_tag_running_procs">trace_tag_running_procs()</seealso></v>
             <v>TracerState = term()</v>
             <v>Tracee = <seealso marker="#type-tracee">tracee()</seealso></v>
-            <v>FirstTraceTerm = term()</v>
-            <v>Opts = <seealso marker="#type-trace_opts">trace_opts()</seealso></v>
-            <v>Result = ok</v>
+            <v>Result = trace | discard | remove</v>
         </type>
         <desc>
-            <p>This callback will be called when a tracepoint is triggered and
-                the <seealso marker="#Module:enabled_running_ports/3">Module:enabled_running_ports/3</seealso>
-                callback returned <c>trace</c>.</p>
-            <p>If <c>trace_running_ports/5</c> is not defined <c>trace/5</c> will be called instead.</p>
+            <p>This callback will be called whenever a tracepoint with trace flag
+                <seealso marker="erlang#trace-3"><c>running_procs | running</c></seealso>
+                is triggered.</p>
+            <p>If <c>enabled_running_procs/3</c> is not defined <c>enabled/3</c> will be called instead.</p>
         </desc>
     </func>
 
     <func>
-        <name>Module:enabled_call(TraceTag, TracerState, Tracee) -> Result</name>
+        <name>Module:enabled_send(TraceTag, TracerState, Tracee) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
         <type>
-            <v>TraceTag = <seealso marker="#type-trace_tag_call">trace_tag_call()</seealso></v>
+            <v>TraceTag = <seealso marker="#type-trace_tag_send">trace_tag_send()</seealso></v>
             <v>TracerState = term()</v>
             <v>Tracee = <seealso marker="#type-tracee">tracee()</seealso></v>
             <v>Result = trace | discard | remove</v>
         </type>
         <desc>
             <p>This callback will be called whenever a tracepoint with trace flag
-                <seealso marker="erlang#trace-3"><c>call | return_to</c></seealso>
+                <seealso marker="erlang#trace-3"><c>send</c></seealso>
                 is triggered.</p>
-            <p>If <c>enabled_call/3</c> is not defined <c>enabled/3</c> will be called instead.</p>
+            <p>If <c>enabled_send/3</c> is not defined <c>enabled/3</c> will be called instead.</p>
         </desc>
     </func>
 
     <func>
+      <name>Module:trace(TraceTag, TracerState, Tracee, TraceTerm, Opts) -> Result</name>
+      <fsummary>Check if a trace event should be generated.</fsummary>
+      <type>
+        <v>TraceTag = <seealso marker="#type-trace_tag">trace_tag()</seealso></v>
+        <v>TracerState = term()</v>
+        <v>Tracee = <seealso marker="#type-tracee">tracee()</seealso></v>
+        <v>FirstTraceTerm = term()</v>
+        <v>Opts = <seealso marker="#type-trace_opts">trace_opts()</seealso></v>
+        <v>Result =  ok</v>
+      </type>
+      <desc>
+        <p>This callback will be called when a tracepoint is triggered and
+        the <seealso marker="#Module:enabled/3">Module:enabled/3</seealso>
+        callback returned <c>trace</c>. In it any side effects needed by
+        the tracer should be done. The tracepoint payload is located in
+        the <c>TraceTerm</c>. The content of the TraceTerm depends on which
+        <c>TraceTag</c> has been triggered.
+        The <c>TraceTerm</c> corresponds to the
+        fourth element in the trace tuples described in
+        <seealso marker="erlang#trace_3_trace_messages">erlang:trace/3</seealso>.
+        If the trace tuple has five elements, the fifth element will be sent as
+        the <c>extra</c> value in the <c>Opts</c> maps.</p>
+      </desc>
+    </func>
+    <func>
+      <name name="trace">Module:trace(seq_trace, TracerState, Label, SeqTraceInfo, Opts) -> Result</name>
+      <fsummary>Check if a sequence trace event should be generated.</fsummary>
+      <type>
+        <v>TracerState = term()</v>
+        <v>Label = term()</v>
+        <v>SeqTraceInfo = term()</v>
+        <v>Opts = <seealso marker="#type-trace_opts">trace_opts()</seealso></v>
+        <v>Result =  ok</v>
+      </type>
+      <desc>
+        <p>The <c>TraceTag</c> <c>seq_trace</c> is handled a little bit
+        differently. There is not <c>Tracee</c> for seq_trace, instead the
+        <c>Label</c> associated with the seq_trace event is given.
+        For more info on what <c>Label</c> and <c>SeqTraceInfo</c> can be
+        see the <seealso marker="kernel:seq_trace">seq_trace</seealso> manual.</p>
+      </desc>
+    </func>
+
+    <func>
         <name>Module:trace_call(TraceTag, TracerState, Tracee, TraceTerm, Opts) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
         <type>
@@ -394,55 +370,59 @@
     </func>
 
     <func>
-        <name>Module:enabled_send(TraceTag, TracerState, Tracee) -> Result</name>
+        <name>Module:trace_garbage_collection(TraceTag, TracerState, Tracee, TraceTerm, Opts) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
         <type>
-            <v>TraceTag = <seealso marker="#type-trace_tag_send">trace_tag_send()</seealso></v>
+            <v>TraceTag = <seealso marker="#type-trace_tag_gc">trace_tag_gc()</seealso></v>
             <v>TracerState = term()</v>
             <v>Tracee = <seealso marker="#type-tracee">tracee()</seealso></v>
-            <v>Result = trace | discard | remove</v>
+            <v>FirstTraceTerm = term()</v>
+            <v>Opts = <seealso marker="#type-trace_opts">trace_opts()</seealso></v>
+            <v>Result =  ok</v>
         </type>
         <desc>
-            <p>This callback will be called whenever a tracepoint with trace flag
-                <seealso marker="erlang#trace-3"><c>send</c></seealso>
-                is triggered.</p>
-            <p>If <c>enabled_send/3</c> is not defined <c>enabled/3</c> will be called instead.</p>
+            <p>This callback will be called when a tracepoint is triggered and
+                the <seealso marker="#Module:enabled_garbage_collection/3">Module:enabled_garbage_collection/3</seealso>
+                callback returned <c>trace</c>.</p>
+            <p>If <c>trace_garbage_collection/5</c> is not defined <c>trace/5</c> will be called instead.</p>
         </desc>
     </func>
 
     <func>
-        <name>Module:trace_send(TraceTag, TracerState, Tracee, TraceTerm, Opts) -> Result</name>
+        <name>Module:trace_ports(TraceTag, TracerState, Tracee, TraceTerm, Opts) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
         <type>
-            <v>TraceTag = <seealso marker="#type-trace_tag_send">trace_tag_send()</seealso></v>
+            <v>TraceTag = <seealso marker="#type-trace_tag_ports">trace_tag()</seealso></v>
             <v>TracerState = term()</v>
             <v>Tracee = <seealso marker="#type-tracee">tracee()</seealso></v>
             <v>FirstTraceTerm = term()</v>
             <v>Opts = <seealso marker="#type-trace_opts">trace_opts()</seealso></v>
-            <v>Result =  ok</v>
+            <v>Result = ok</v>
         </type>
         <desc>
             <p>This callback will be called when a tracepoint is triggered and
-                the <seealso marker="#Module:enabled_send/3">Module:enabled_send/3</seealso>
+                the <seealso marker="#Module:enabled_ports/3">Module:enabled_ports/3</seealso>
                 callback returned <c>trace</c>.</p>
-            <p>If <c>trace_send/5</c> is not defined <c>trace/5</c> will be called instead.</p>
+            <p>If <c>trace_ports/5</c> is not defined <c>trace/5</c> will be called instead.</p>
         </desc>
     </func>
 
     <func>
-        <name>Module:enabled_receive(TraceTag, TracerState, Tracee) -> Result</name>
+        <name>Module:trace_procs(TraceTag, TracerState, Tracee, TraceTerm, Opts) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
         <type>
-            <v>TraceTag = <seealso marker="#type-trace_tag_receive">trace_tag_receive()</seealso></v>
+            <v>TraceTag = <seealso marker="#type-trace_tag_procs">trace_tag()</seealso></v>
             <v>TracerState = term()</v>
             <v>Tracee = <seealso marker="#type-tracee">tracee()</seealso></v>
-            <v>Result = trace | discard | remove</v>
+            <v>FirstTraceTerm = term()</v>
+            <v>Opts = <seealso marker="#type-trace_opts">trace_opts()</seealso></v>
+            <v>Result = ok</v>
         </type>
         <desc>
-            <p>This callback will be called whenever a tracepoint with trace flag
-                <seealso marker="erlang#trace-3"><c>'receive'</c></seealso>
-                is triggered.</p>
-            <p>If <c>enabled_receive/3</c> is not defined <c>enabled/3</c> will be called instead.</p>
+            <p>This callback will be called when a tracepoint is triggered and
+                the <seealso marker="#Module:enabled_procs/3">Module:enabled_procs/3</seealso>
+                callback returned <c>trace</c>.</p>
+            <p>If <c>trace_procs/5</c> is not defined <c>trace/5</c> will be called instead.</p>
         </desc>
     </func>
 
@@ -466,27 +446,48 @@
     </func>
 
     <func>
-        <name>Module:enabled_garbage_collection(TraceTag, TracerState, Tracee) -> Result</name>
+        <name>Module:trace_running_ports(TraceTag, TracerState, Tracee, TraceTerm, Opts) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
         <type>
-            <v>TraceTag = <seealso marker="#type-trace_tag_gc">trace_tag_gc()</seealso></v>
+            <v>TraceTag = <seealso marker="#type-trace_tag_running_ports">trace_tag_running_ports()</seealso></v>
             <v>TracerState = term()</v>
             <v>Tracee = <seealso marker="#type-tracee">tracee()</seealso></v>
-            <v>Result = trace | discard | remove</v>
+            <v>FirstTraceTerm = term()</v>
+            <v>Opts = <seealso marker="#type-trace_opts">trace_opts()</seealso></v>
+            <v>Result = ok</v>
         </type>
         <desc>
-            <p>This callback will be called whenever a tracepoint with trace flag
-                <seealso marker="erlang#trace-3"><c>garbage_collection</c></seealso>
-                is triggered.</p>
-            <p>If <c>enabled_garbage_collection/3</c> is not defined <c>enabled/3</c> will be called instead.</p>
+            <p>This callback will be called when a tracepoint is triggered and
+                the <seealso marker="#Module:enabled_running_ports/3">Module:enabled_running_ports/3</seealso>
+                callback returned <c>trace</c>.</p>
+            <p>If <c>trace_running_ports/5</c> is not defined <c>trace/5</c> will be called instead.</p>
         </desc>
     </func>
 
     <func>
-        <name>Module:trace_garbage_collection(TraceTag, TracerState, Tracee, TraceTerm, Opts) -> Result</name>
+        <name>Module:trace_running_procs(TraceTag, TracerState, Tracee, TraceTerm, Opts) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
         <type>
-            <v>TraceTag = <seealso marker="#type-trace_tag_gc">trace_tag_gc()</seealso></v>
+            <v>TraceTag = <seealso marker="#type-trace_tag_running_procs">trace_tag_running_procs()</seealso></v>
+            <v>TracerState = term()</v>
+            <v>Tracee = <seealso marker="#type-tracee">tracee()</seealso></v>
+            <v>FirstTraceTerm = term()</v>
+            <v>Opts = <seealso marker="#type-trace_opts">trace_opts()</seealso></v>
+            <v>Result = ok</v>
+        </type>
+        <desc>
+            <p>This callback will be called when a tracepoint is triggered and
+                the <seealso marker="#Module:enabled_running_procs/3">Module:enabled_running_procs/3</seealso>
+                callback returned <c>trace</c>.</p>
+            <p>If <c>trace_running_procs/5</c> is not defined <c>trace/5</c> will be called instead.</p>
+        </desc>
+    </func>
+
+    <func>
+        <name>Module:trace_send(TraceTag, TracerState, Tracee, TraceTerm, Opts) -> Result</name>
+        <fsummary>Check if a trace event should be generated.</fsummary>
+        <type>
+            <v>TraceTag = <seealso marker="#type-trace_tag_send">trace_tag_send()</seealso></v>
             <v>TracerState = term()</v>
             <v>Tracee = <seealso marker="#type-tracee">tracee()</seealso></v>
             <v>FirstTraceTerm = term()</v>
@@ -495,9 +496,9 @@
         </type>
         <desc>
             <p>This callback will be called when a tracepoint is triggered and
-                the <seealso marker="#Module:enabled_garbage_collection/3">Module:enabled_garbage_collection/3</seealso>
+                the <seealso marker="#Module:enabled_send/3">Module:enabled_send/3</seealso>
                 callback returned <c>trace</c>.</p>
-            <p>If <c>trace_garbage_collection/5</c> is not defined <c>trace/5</c> will be called instead.</p>
+            <p>If <c>trace_send/5</c> is not defined <c>trace/5</c> will be called instead.</p>
         </desc>
     </func>