From 20cc39d443d1a2c364b0fb778c7813ae7b5a1dd6 Mon Sep 17 00:00:00 2001
From: Sverker Eriksson <sverker@erlang.org>
Date: Tue, 11 Dec 2018 17:42:39 +0100
Subject: Add "since" attributes in xml for new functions and modules

introduced after OTP_R13B03.
---
 lib/runtime_tools/doc/src/dbg.xml                |  4 +--
 lib/runtime_tools/doc/src/dyntrace.xml           | 32 ++++++++++++------------
 lib/runtime_tools/doc/src/msacc.xml              | 32 ++++++++++++------------
 lib/runtime_tools/doc/src/scheduler.xml          | 12 ++++-----
 lib/runtime_tools/doc/src/system_information.xml |  6 ++---
 5 files changed, 43 insertions(+), 43 deletions(-)

(limited to 'lib/runtime_tools')

diff --git a/lib/runtime_tools/doc/src/dbg.xml b/lib/runtime_tools/doc/src/dbg.xml
index 3262cafefc..06701ed5b4 100644
--- a/lib/runtime_tools/doc/src/dbg.xml
+++ b/lib/runtime_tools/doc/src/dbg.xml
@@ -442,7 +442,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\
 
 
     <func>
-      <name>tpe(Event, MatchSpec) -> {ok, MatchDesc} | {error, term()}</name>
+      <name since="OTP 19.0">tpe(Event, MatchSpec) -> {ok, MatchDesc} | {error, term()}</name>
       <fsummary>Set pattern for traced event</fsummary>
       <type>
 	<v>Event = send | 'receive'</v>
@@ -607,7 +607,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\
       </desc>
     </func>
     <func>
-      <name>ctpe(Event) -> {ok, MatchDesc} | {error, term()}</name>
+      <name since="OTP 19.0">ctpe(Event) -> {ok, MatchDesc} | {error, term()}</name>
       <fsummary>Clear trace pattern for the specified event</fsummary>
       <type>
         <v>Event = send | 'receive'</v>
diff --git a/lib/runtime_tools/doc/src/dyntrace.xml b/lib/runtime_tools/doc/src/dyntrace.xml
index 0cdcecab68..4935dfcd71 100644
--- a/lib/runtime_tools/doc/src/dyntrace.xml
+++ b/lib/runtime_tools/doc/src/dyntrace.xml
@@ -32,7 +32,7 @@
     <rev>A</rev>
     <file>dyntrace.xml</file>
   </header>
-  <module>dyntrace</module>
+  <module since="OTP R15B01">dyntrace</module>
   <modulesummary>Interface to dynamic tracing</modulesummary>
   <description>
     <p>This module implements interfaces to dynamic tracing, should such be compiled into the virtual machine. For a standard and/or commercial build, no dynamic tracing is available, in which case none of the functions in this module is usable or give any effect.</p>
@@ -47,7 +47,7 @@
   </description>
   <funcs>
     <func>
-      <name>available() -> boolean()</name>
+      <name since="OTP R15B01">available() -> boolean()</name>
       <fsummary>Check if dynamic tracing is available</fsummary>
       <desc>
 	<p>This function uses the NIF library to determine if dynamic
@@ -59,42 +59,42 @@
       </desc>
     </func>
     <func>
-      <name>p() -> true | false | error | badarg</name>
+      <name since="OTP R15B01">p() -> true | false | error | badarg</name>
       <fsummary>Trigger the user trace probe.</fsummary>
       <desc>
         <p>Calling this function will trigger the "user" trace probe user_trace_i4s4 in the dyntrace NIF module, sending a trace message only containing the user tag and zeroes/empty strings in all other fields.</p>
       </desc>
     </func>
     <func>
-      <name>p(integer() | string()) -> true | false | error | badarg</name>
+      <name since="OTP R15B01">p(integer() | string()) -> true | false | error | badarg</name>
       <fsummary>Trigger the user trace probe.</fsummary>
       <desc>
         <p>Calling this function will trigger the "user" trace probe user_trace_i4s4 in the dyntrace NIF module, sending a trace message containing the user tag and the integer or string parameter in the first integer/string field.</p>
       </desc>
     </func>
     <func>
-      <name>p(integer() | string(), integer() | string()) -> true | false | error | badarg</name>
+      <name since="OTP R15B01">p(integer() | string(), integer() | string()) -> true | false | error | badarg</name>
       <fsummary>Trigger the user trace probe.</fsummary>
       <desc>
         <p>Calling this function will trigger the "user" trace probe user_trace_i4s4 in the dyntrace NIF module, sending a trace message containing the user tag and the integer() or string() parameters as the first fields of respective type. integer() parameters should be put before any string() parameters. I.e. <c>p(1,"Hello")</c> is ok, as is <c>p(1,1)</c> and <c>p("Hello","Again")</c>, but not <c>p("Hello",1)</c>.</p>
       </desc>
     </func>
     <func>
-      <name>p(integer() | string(), integer() | string(), integer() | string()) -> true | false | error | badarg</name>
+      <name since="OTP R15B01">p(integer() | string(), integer() | string(), integer() | string()) -> true | false | error | badarg</name>
       <fsummary>Trigger the user trace probe.</fsummary>
       <desc>
         <p>Calling this function will trigger the "user" trace probe user_trace_i4s4 in the dyntrace NIF module, sending a trace message containing the user tag and the integer() or string() parameters as the first fields of respective type. integer() parameters should be put before any string() parameters, as in <seealso marker="#p/2">p/2</seealso>.</p>
       </desc>
     </func>
     <func>
-      <name>p(integer() | string(), integer() | string(), integer() | string(), integer() | string()) -> true | false | error | badarg</name>
+      <name since="OTP R15B01">p(integer() | string(), integer() | string(), integer() | string(), integer() | string()) -> true | false | error | badarg</name>
       <fsummary>Trigger the user trace probe.</fsummary>
       <desc>
         <p>Calling this function will trigger the "user" trace probe user_trace_i4s4 in the dyntrace NIF module, sending a trace message containing the user tag and the integer() or string() parameters as the first fields of respective type. integer() parameters should be put before any string() parameters, as in <seealso marker="#p/2">p/2</seealso>.</p>
       </desc>
     </func>
     <func>
-      <name>p(integer(), integer() | string(), integer() | string(), integer() | string(), string()) -> true | false | error | badarg</name>
+      <name since="OTP R15B01">p(integer(), integer() | string(), integer() | string(), integer() | string(), string()) -> true | false | error | badarg</name>
       <fsummary>Trigger the user trace probe.</fsummary>
       <desc>
         <p>Calling this function will trigger the "user" trace probe user_trace_i4s4 in the dyntrace NIF module, sending a trace message containing the user tag and the integer() or string() parameters as the first fields of respective type. integer() parameters should be put before any string() parameters, as in <seealso marker="#p/2">p/2</seealso>.</p>
@@ -102,7 +102,7 @@
       </desc>
     </func>
      <func>
-      <name>p(integer(), integer(), integer() | string(), integer() | string(), string(), string()) -> true | false | error | badarg</name>
+      <name since="OTP R15B01">p(integer(), integer(), integer() | string(), integer() | string(), string(), string()) -> true | false | error | badarg</name>
       <fsummary>Trigger the user trace probe.</fsummary>
       <desc>
         <p>Calling this function will trigger the "user" trace probe user_trace_i4s4 in the dyntrace NIF module, sending a trace message containing the user tag and the integer() or string() parameters as the first fields of respective type. integer() parameters should be put before any string() parameters, as in <seealso marker="#p/2">p/2</seealso>.</p>
@@ -110,7 +110,7 @@
       </desc>
     </func>
      <func>
-      <name>p(integer(), integer(), integer(), integer() | string(), string(), string(), string()) -> true | false | error | badarg</name>
+      <name since="OTP R15B01">p(integer(), integer(), integer(), integer() | string(), string(), string(), string()) -> true | false | error | badarg</name>
       <fsummary>Trigger the user trace probe.</fsummary>
       <desc>
         <p>Calling this function will trigger the "user" trace probe user_trace_i4s4 in the dyntrace NIF module, sending a trace message containing the user tag and the integer() or string() parameters as the first fields of respective type. integer() parameters should be put before any string() parameters, as in <seealso marker="#p/2">p/2</seealso>.</p>
@@ -118,14 +118,14 @@
       </desc>
     </func>
      <func>
-      <name>p(integer(), integer(), integer(), integer(), string(), string(), string(), string()) -> true | false | error | badarg</name>
+      <name since="OTP R15B01">p(integer(), integer(), integer(), integer(), string(), string(), string(), string()) -> true | false | error | badarg</name>
       <fsummary>Trigger the user trace probe.</fsummary>
       <desc>
         <p>Calling this function will trigger the "user" trace probe user_trace_i4s4 in the dyntrace NIF module, sending a trace message containing all the integer()'s and string()'s provided, as well as any user tag set in the current process.</p> 
       </desc>
     </func>
     <func>
-      <name>get_tag() -> binary() | undefined</name>
+      <name since="OTP R15B01">get_tag() -> binary() | undefined</name>
       <fsummary>Get the user tag set in the process.</fsummary>
       <desc>
 	<p>This function returns the user tag set in the current
@@ -134,7 +134,7 @@
       </desc>
     </func>
     <func>
-      <name>get_tag() -> binary() | undefined</name>
+      <name since="OTP R15B01">get_tag() -> binary() | undefined</name>
       <fsummary>Get the user tag set in the process or sent to the process.</fsummary>
       <desc>
 	<p>This function returns the user tag set in the current
@@ -151,7 +151,7 @@
     </func>
     
     <func>
-      <name>put_tag(Item) -> binary() | undefined </name>
+      <name since="OTP R15B01">put_tag(Item) -> binary() | undefined </name>
       <fsummary>Set the user tag of the current process.</fsummary>
       <type>
         <v>Item = iodata()</v>
@@ -163,7 +163,7 @@
       </desc>
     </func>
     <func>
-      <name>spread_tag(boolean()) -> TagData</name>
+      <name since="OTP R15B01">spread_tag(boolean()) -> TagData</name>
       <fsummary>Start or stop spreading dynamic trace user tags with the next message.</fsummary>
       <type>
         <v>TagData = opaque data that can be used as parameter to <seealso marker="#restore_tag/1">restore_tag/1</seealso></v>
@@ -185,7 +185,7 @@ f() ->
       </desc>
     </func>
     <func>
-    <name>restore_tag(TagData) -> true</name>
+    <name since="OTP R15B01">restore_tag(TagData) -> true</name>
       <fsummary>Restore to a previous state of user tag spreading.</fsummary>
       <type>
         <v>TagData = opaque data returned by <seealso marker="#spread_tag/1">spread_tag/1</seealso></v>
diff --git a/lib/runtime_tools/doc/src/msacc.xml b/lib/runtime_tools/doc/src/msacc.xml
index 129da3d230..ae089de8d0 100644
--- a/lib/runtime_tools/doc/src/msacc.xml
+++ b/lib/runtime_tools/doc/src/msacc.xml
@@ -31,7 +31,7 @@
     <rev>A</rev>
     <file>msacc.xml</file>
   </header>
-  <module>msacc</module>
+  <module since="OTP 19.0">msacc</module>
   <modulesummary>Convenience functions for microstate accounting</modulesummary>
   <description>
     <p>This module implements some convenience functions for analyzing
@@ -146,7 +146,7 @@ ok
   </datatypes>
   <funcs>
     <func>
-      <name name="available" arity="0"/>
+      <name name="available" arity="0" since="OTP 19.0"/>
       <fsummary>Check if microstate accounting is available</fsummary>
       <desc>
 	<p>This function checks whether microstate accounting
@@ -154,7 +154,7 @@ ok
       </desc>
     </func>
     <func>
-      <name name="start" arity="0"/>
+      <name name="start" arity="0" since="OTP 19.0"/>
       <fsummary>Start microstate accounting.</fsummary>
       <desc>
         <p>Start microstate accounting. Returns whether it was
@@ -162,7 +162,7 @@ ok
       </desc>
     </func>
     <func>
-      <name name="start" arity="1"/>
+      <name name="start" arity="1" since="OTP 19.0"/>
       <fsummary>Start microstate accounting for a time.</fsummary>
       <desc>
         <p>Resets all counters and then starts microstate accounting
@@ -170,7 +170,7 @@ ok
       </desc>
     </func>
     <func>
-      <name name="stop" arity="0"/>
+      <name name="stop" arity="0" since="OTP 19.0"/>
       <fsummary>Stop microstate accounting.</fsummary>
       <desc>
         <p>Stop microstate accounting.
@@ -178,7 +178,7 @@ ok
       </desc>
     </func>
     <func>
-      <name name="reset" arity="0"/>
+      <name name="reset" arity="0" since="OTP 19.0"/>
       <fsummary>Reset microstate accounting counters</fsummary>
       <desc>
         <p>Reset microstate accounting counters.
@@ -186,7 +186,7 @@ ok
       </desc>
     </func>
     <func>
-      <name name="print" arity="0"/>
+      <name name="print" arity="0" since="OTP 19.0"/>
       <fsummary>Print microstate statistics</fsummary>
       <desc>
         <p>
@@ -199,7 +199,7 @@ ok
       </desc>
     </func>
     <func>
-      <name name="print" arity="1"/>
+      <name name="print" arity="1" since="OTP 19.0"/>
       <fsummary>Print microstate statistics</fsummary>
       <desc>
         <p>Print the given microstate statistics values to stdout.
@@ -211,7 +211,7 @@ ok
       </desc>
     </func>
     <func>
-      <name name="print" arity="2"/>
+      <name name="print" arity="2" since="OTP 19.0"/>
       <fsummary>Print microstate statistics</fsummary>
       <desc>
         <p>Print the given microstate statistics values to standard out.
@@ -234,7 +234,7 @@ ok
       </desc>
     </func>
     <func>
-      <name name="print" arity="3"/>
+      <name name="print" arity="3" since="OTP 19.0"/>
       <fsummary>Print microstate statistics</fsummary>
       <desc>
         <p>Print the given microstate statistics values to the given file
@@ -243,7 +243,7 @@ ok
       </desc>
     </func>
     <func>
-      <name name="stats" arity="0"/>
+      <name name="stats" arity="0" since="OTP 19.0"/>
       <fsummary></fsummary>
       <desc>
         <p>Returns a runtime system independent version of the microstate
@@ -254,7 +254,7 @@ ok
       </desc>
     </func>
     <func>
-      <name name="stats" arity="2" clause_i="1"/>
+      <name name="stats" arity="2" clause_i="1" since="OTP 19.0"/>
       <fsummary></fsummary>
       <desc>
         <p>Returns the system time for the given microstate statistics values.
@@ -269,7 +269,7 @@ ok
       </desc>
     </func>
     <func>
-      <name name="stats" arity="2" clause_i="2"/>
+      <name name="stats" arity="2" clause_i="2" since="OTP 19.0"/>
       <fsummary></fsummary>
       <desc>
         <p>Returns fractions of real-time or run-time spent in the various
@@ -277,7 +277,7 @@ ok
       </desc>
     </func>
     <func>
-      <name name="stats" arity="2" clause_i="3"/>
+      <name name="stats" arity="2" clause_i="3" since="OTP 19.0"/>
       <fsummary></fsummary>
       <desc>
         <p>Returns a list of microstate statistics values where the values
@@ -285,7 +285,7 @@ ok
       </desc>
     </func>
     <func>
-      <name name="to_file" arity="1"/>
+      <name name="to_file" arity="1" since="OTP 19.0"/>
       <fsummary></fsummary>
       <desc>
         <p>Dumps the current microstate statistics counters to a file that can
@@ -294,7 +294,7 @@ ok
       </desc>
     </func>
     <func>
-      <name name="from_file" arity="1"/>
+      <name name="from_file" arity="1" since="OTP 19.0"/>
       <fsummary></fsummary>
       <desc>
         <p>Read a file dump produced by <seealso marker="#to_file/1">
diff --git a/lib/runtime_tools/doc/src/scheduler.xml b/lib/runtime_tools/doc/src/scheduler.xml
index dd8bf73bae..b033430183 100644
--- a/lib/runtime_tools/doc/src/scheduler.xml
+++ b/lib/runtime_tools/doc/src/scheduler.xml
@@ -32,7 +32,7 @@
     <rev></rev>
     <file>scheduler.xml</file>
   </header>
-  <module>scheduler</module>
+  <module since="OTP 21.0">scheduler</module>
   <modulesummary>Measure scheduler utilization</modulesummary>
   <description>
     <p>This module contains utility functions for easier measurement and
@@ -84,7 +84,7 @@
   <funcs>
 
     <func>
-      <name name="sample" arity="0"/>
+      <name name="sample" arity="0" since="OTP 21.0"/>
       <fsummary>Get scheduler utilization sample.</fsummary>
       <desc>
         <p>Return a scheduler utilization sample for normal and dirty-cpu
@@ -93,7 +93,7 @@
     </func>
 
     <func>
-      <name name="sample_all" arity="0"/>
+      <name name="sample_all" arity="0" since="OTP 21.0"/>
       <fsummary>Get scheduler utilization sample.</fsummary>
       <desc>
         <p>Return a scheduler utilization sample for all schedulers,
@@ -102,7 +102,7 @@
     </func>
 
     <func>
-      <name name="utilization" arity="1" clause_i="1"/>
+      <name name="utilization" arity="1" clause_i="1" since="OTP 21.0"/>
       <fsummary>Measure scheduler utilizations during a period of time.</fsummary>
       <desc>
         <p>Measure utilization for normal and dirty-cpu schedulers during
@@ -111,7 +111,7 @@
     </func>
 
     <func>
-      <name name="utilization" arity="1" clause_i="2"/>
+      <name name="utilization" arity="1" clause_i="2" since="OTP 21.0"/>
       <fsummary>Measure scheduler utilizations since sample.</fsummary>
       <desc>
         <p>Calculate scheduler utilizations for the time interval from when
@@ -121,7 +121,7 @@
     </func>
 
     <func>
-      <name name="utilization" arity="2"/>
+      <name name="utilization" arity="2" since="OTP 21.0"/>
       <fsummary>Measure scheduler utilizations between two samples.</fsummary>
       <desc>
 	<p>Calculates scheduler utilizations for the time interval between
diff --git a/lib/runtime_tools/doc/src/system_information.xml b/lib/runtime_tools/doc/src/system_information.xml
index 53dc595e64..a356b5c6f8 100644
--- a/lib/runtime_tools/doc/src/system_information.xml
+++ b/lib/runtime_tools/doc/src/system_information.xml
@@ -32,14 +32,14 @@
     <rev></rev>
     <file>system_information.xml</file>
   </header>
-  <module>system_information</module>
+  <module since="OTP 17.0">system_information</module>
   <modulesummary>System Information</modulesummary>
   <description>
     <p></p>
   </description>
   <funcs>
     <func>
-      <name name="sanity_check" arity="0"/>
+      <name name="sanity_check" arity="0" since="OTP 17.0"/>
       <fsummary>Perform a sanity check</fsummary>
       <desc>
         <p>Performs a sanity check on the system. If no issues
@@ -88,7 +88,7 @@
       </desc>
     </func>
     <func>
-      <name name="to_file" arity="1"/>
+      <name name="to_file" arity="1" since="OTP 17.0"/>
       <fsummary>Write miscellaneous system information to file</fsummary>
       <desc><p>Writes  miscellaneous system information to file. This
       information will typically be requested by the Erlang/OTP team
-- 
cgit v1.2.3