diff options
| author | Sverker Eriksson <[email protected]> | 2018-12-12 19:32:24 +0100 | 
|---|---|---|
| committer | Sverker Eriksson <[email protected]> | 2018-12-12 21:21:26 +0100 | 
| commit | 50f64c60b87e8d03fedc3f9f4e655aff8ca9f16c (patch) | |
| tree | b6f900f445ca4af43a9442139134d54847f9b3cb /lib/sasl/doc/src | |
| parent | 8084754341acd6363ff975b6dd758f1eb6514332 (diff) | |
| download | otp-50f64c60b87e8d03fedc3f9f4e655aff8ca9f16c.tar.gz otp-50f64c60b87e8d03fedc3f9f4e655aff8ca9f16c.tar.bz2 otp-50f64c60b87e8d03fedc3f9f4e655aff8ca9f16c.zip | |
Add empty 'since' attribute for old modules and functions
Diffstat (limited to 'lib/sasl/doc/src')
| -rw-r--r-- | lib/sasl/doc/src/alarm_handler.xml | 8 | ||||
| -rw-r--r-- | lib/sasl/doc/src/rb.xml | 30 | ||||
| -rw-r--r-- | lib/sasl/doc/src/release_handler.xml | 38 | ||||
| -rw-r--r-- | lib/sasl/doc/src/systools.xml | 16 | 
4 files changed, 46 insertions, 46 deletions
| diff --git a/lib/sasl/doc/src/alarm_handler.xml b/lib/sasl/doc/src/alarm_handler.xml index 4160757164..6e74f833cd 100644 --- a/lib/sasl/doc/src/alarm_handler.xml +++ b/lib/sasl/doc/src/alarm_handler.xml @@ -34,7 +34,7 @@      <rev>A</rev>      <file>alarm_handler.sgml.t1</file>    </header> -  <module>alarm_handler</module> +  <module since="">alarm_handler</module>    <modulesummary>An Alarm Handling Process</modulesummary>    <description>      <p>The alarm handler process is a  @@ -81,7 +81,7 @@    <funcs>      <func> -      <name>clear_alarm(AlarmId) -> void()</name> +      <name since="">clear_alarm(AlarmId) -> void()</name>        <fsummary>Clears the specified alarms.</fsummary>        <type>          <v>AlarmId = term()</v> @@ -94,7 +94,7 @@      </func>      <func> -      <name>get_alarms() -> [alarm()]</name> +      <name since="">get_alarms() -> [alarm()]</name>        <fsummary>Gets all active alarms.</fsummary>        <desc>          <p>Returns a list of all active alarms. This function can only @@ -103,7 +103,7 @@      </func>      <func> -      <name>set_alarm(alarm())</name> +      <name since="">set_alarm(alarm())</name>        <fsummary>Sets an alarm with an id.</fsummary>        <type>          <v>alarm() = {AlarmId, AlarmDescription}</v> diff --git a/lib/sasl/doc/src/rb.xml b/lib/sasl/doc/src/rb.xml index 6e118e177b..0ed7e91c11 100644 --- a/lib/sasl/doc/src/rb.xml +++ b/lib/sasl/doc/src/rb.xml @@ -32,7 +32,7 @@      <rev>A</rev>      <file>rb.sgml</file>    </header> -  <module>rb</module> +  <module since="">rb</module>    <modulesummary>The Report Browser Tool</modulesummary>    <description>      <p>The Report Browser (RB) tool is used to browse and @@ -86,7 +86,7 @@      </func>      <func> -      <name>grep(RegExp)</name> +      <name since="">grep(RegExp)</name>        <fsummary>Searches the reports for a regular expression.</fsummary>        <type>          <v>RegExp = string() | {string(), Options} | re:mp() | {re:mp(), Options}</v> @@ -109,8 +109,8 @@      </func>      <func> -      <name>h()</name> -      <name>help()</name> +      <name since="">h()</name> +      <name since="">help()</name>        <fsummary>Displays help information.</fsummary>        <desc>          <p>Displays online help information.</p> @@ -118,8 +118,8 @@      </func>      <func> -      <name>list()</name> -      <name>list(Type)</name> +      <name since="">list()</name> +      <name since="">list(Type)</name>        <fsummary>Lists all reports.</fsummary>        <type>          <v>Type = type()</v> @@ -157,8 +157,8 @@      </func>      <func> -      <name>rescan()</name> -      <name>rescan(Options)</name> +      <name since="">rescan()</name> +      <name since="">rescan(Options)</name>        <fsummary>Rescans the report directory.</fsummary>        <type>          <v>Options = [opt()]</v> @@ -171,8 +171,8 @@      </func>      <func> -      <name>show()</name> -      <name>show(Report)</name> +      <name since="">show()</name> +      <name since="">show(Report)</name>        <fsummary>Displays reports.</fsummary>        <type>          <v>Report = integer() | type()</v> @@ -186,8 +186,8 @@      </func>      <func> -      <name>start()</name> -      <name>start(Options)</name> +      <name since="">start()</name> +      <name since="">start(Options)</name>        <fsummary>Starts the <c>rb_server</c>.</fsummary>        <type>          <v>Options = [opt()]</v> @@ -256,7 +256,7 @@      </func>      <func> -      <name>start_log(FileName)</name> +      <name since="">start_log(FileName)</name>        <fsummary>Redirects all output to <c>FileName</c>.</fsummary>        <type>          <v>FileName = string() | atom() | pid()</v> @@ -268,7 +268,7 @@      </func>      <func> -      <name>stop()</name> +      <name since="">stop()</name>        <fsummary>Stops the <c>rb_server</c>.</fsummary>        <desc>          <p>Stops <c>rb_server</c>.</p> @@ -276,7 +276,7 @@      </func>      <func> -      <name>stop_log()</name> +      <name since="">stop_log()</name>        <fsummary>Stops logging to file.</fsummary>        <desc>          <p>Closes the log file. The output from the RB tool is diff --git a/lib/sasl/doc/src/release_handler.xml b/lib/sasl/doc/src/release_handler.xml index a77dace675..f8ee0306d8 100644 --- a/lib/sasl/doc/src/release_handler.xml +++ b/lib/sasl/doc/src/release_handler.xml @@ -28,7 +28,7 @@      <date></date>      <rev></rev>    </header> -  <module>release_handler</module> +  <module since="">release_handler</module>    <modulesummary>Unpacking and Installation of Release Packages</modulesummary>    <description>      <p>The <em>release handler</em> process belongs to the SASL @@ -168,7 +168,7 @@    <funcs>      <func> -      <name>check_install_release(Vsn) -> {ok, OtherVsn, Descr} | {error, Reason}</name> +      <name since="">check_install_release(Vsn) -> {ok, OtherVsn, Descr} | {error, Reason}</name>        <name since="OTP R14B04">check_install_release(Vsn,Opts) -> {ok, OtherVsn, Descr} | {error, Reason}</name>        <fsummary>Checks installation of a release in the system.</fsummary>        <type> @@ -202,7 +202,7 @@      </func>      <func> -      <name>create_RELEASES(Root, RelDir, RelFile, AppDirs) -> ok | {error, Reason}</name> +      <name since="">create_RELEASES(Root, RelDir, RelFile, AppDirs) -> ok | {error, Reason}</name>        <fsummary>Creates an initial <c>RELEASES</c> file.</fsummary>        <type>          <v>Root = RelDir = RelFile = string()</v> @@ -233,7 +233,7 @@      </func>      <func> -      <name>install_file(Vsn, File) -> ok | {error, Reason}</name> +      <name since="">install_file(Vsn, File) -> ok | {error, Reason}</name>        <fsummary>Installs a release file in the release structure.</fsummary>        <type>          <v>Vsn = File = string()</v> @@ -252,8 +252,8 @@      </func>      <func> -      <name>install_release(Vsn) -> {ok, OtherVsn, Descr} | {error, Reason}</name> -      <name>install_release(Vsn, [Opt]) -> {ok, OtherVsn, Descr} | {continue_after_restart, OtherVsn, Descr} | {error, Reason}</name> +      <name since="">install_release(Vsn) -> {ok, OtherVsn, Descr} | {error, Reason}</name> +      <name since="">install_release(Vsn, [Opt]) -> {ok, OtherVsn, Descr} | {continue_after_restart, OtherVsn, Descr} | {error, Reason}</name>        <fsummary>Installs a release in the system.</fsummary>        <type>          <v>Vsn = OtherVsn = string()</v> @@ -383,7 +383,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]).      </func>      <func> -      <name>make_permanent(Vsn) -> ok | {error, Reason}</name> +      <name since="">make_permanent(Vsn) -> ok | {error, Reason}</name>        <fsummary>Makes the specified release version permanent.</fsummary>        <type>          <v>Vsn = string()</v> @@ -396,7 +396,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]).      </func>      <func> -      <name>remove_release(Vsn) -> ok | {error, Reason}</name> +      <name since="">remove_release(Vsn) -> ok | {error, Reason}</name>        <fsummary>Removes a release from the system.</fsummary>        <type>          <v>Vsn = string()</v> @@ -410,7 +410,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]).      </func>      <func> -      <name>reboot_old_release(Vsn) -> ok | {error, Reason}</name> +      <name since="">reboot_old_release(Vsn) -> ok | {error, Reason}</name>        <fsummary>Reboots the system from an old release.</fsummary>        <type>          <v>Vsn = string()</v> @@ -425,7 +425,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]).      </func>      <func> -      <name>set_removed(Vsn) -> ok | {error, Reason}</name> +      <name since="">set_removed(Vsn) -> ok | {error, Reason}</name>        <fsummary>Marks a release as removed.</fsummary>        <type>          <v>Vsn = string()</v> @@ -440,7 +440,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]).      </func>      <func> -      <name>set_unpacked(RelFile, AppDirs) -> {ok, Vsn} | {error, Reason}</name> +      <name since="">set_unpacked(RelFile, AppDirs) -> {ok, Vsn} | {error, Reason}</name>        <fsummary>Marks a release as unpacked.</fsummary>        <type>          <v>RelFile = string()</v> @@ -466,7 +466,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]).      </func>      <func> -      <name>unpack_release(Name) -> {ok, Vsn} | {error, Reason}</name> +      <name since="">unpack_release(Name) -> {ok, Vsn} | {error, Reason}</name>        <fsummary>Unpacks a release package.</fsummary>        <type>          <v>Name = Vsn = string()</v> @@ -482,7 +482,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]).      </func>      <func> -      <name>which_releases() -> [{Name, Vsn, Apps, Status}]</name> +      <name since="">which_releases() -> [{Name, Vsn, Apps, Status}]</name>        <fsummary>Returns all known releases.</fsummary>        <type>          <v>Name = Vsn = string()</v> @@ -537,7 +537,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]).    <funcs>      <func> -      <name>upgrade_app(App, Dir) -> {ok, Unpurged} | restart_emulator | {error, Reason}</name> +      <name since="">upgrade_app(App, Dir) -> {ok, Unpurged} | restart_emulator | {error, Reason}</name>        <fsummary>Upgrades to a new application version.</fsummary>        <type>          <v>App = atom()</v> @@ -586,8 +586,8 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]).      </func>      <func> -      <name>downgrade_app(App, Dir) -></name> -      <name>downgrade_app(App, OldVsn, Dir) -> {ok, Unpurged} | restart_emulator | {error, Reason}</name> +      <name since="">downgrade_app(App, Dir) -></name> +      <name since="">downgrade_app(App, OldVsn, Dir) -> {ok, Unpurged} | restart_emulator | {error, Reason}</name>        <fsummary>Downgrades to a previous application version.</fsummary>        <type>          <v>App = atom()</v> @@ -633,7 +633,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]).      </func>      <func> -      <name>upgrade_script(App, Dir) -> {ok, NewVsn, Script}</name> +      <name since="">upgrade_script(App, Dir) -> {ok, NewVsn, Script}</name>        <fsummary>Finds an application upgrade script.</fsummary>        <type>          <v>App = atom()</v> @@ -671,7 +671,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]).      </func>      <func> -      <name>downgrade_script(App, OldVsn, Dir) -> {ok, Script}</name> +      <name since="">downgrade_script(App, OldVsn, Dir) -> {ok, Script}</name>        <fsummary>Finds an application downgrade script.</fsummary>        <type>          <v>App = atom()</v> @@ -710,7 +710,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]).      </func>      <func> -      <name>eval_appup_script(App, ToVsn, ToDir, Script) -> {ok, Unpurged} | restart_emulator | {error, Reason}</name> +      <name since="">eval_appup_script(App, ToVsn, ToDir, Script) -> {ok, Unpurged} | restart_emulator | {error, Reason}</name>        <fsummary>Evaluates an application upgrade or downgrade script.</fsummary>        <type>          <v>App = atom()</v> diff --git a/lib/sasl/doc/src/systools.xml b/lib/sasl/doc/src/systools.xml index 4842c732b1..6facb8ddae 100644 --- a/lib/sasl/doc/src/systools.xml +++ b/lib/sasl/doc/src/systools.xml @@ -30,7 +30,7 @@      <date></date>      <rev></rev>    </header> -  <module>systools</module> +  <module since="">systools</module>    <modulesummary>A Set of Release Handling Tools</modulesummary>    <description>      <p>This module contains functions to generate boot scripts @@ -40,8 +40,8 @@    <funcs>      <func> -      <name>make_relup(Name, UpFrom, DownTo) -> Result</name> -      <name>make_relup(Name, UpFrom, DownTo, [Opt]) -> Result</name> +      <name since="">make_relup(Name, UpFrom, DownTo) -> Result</name> +      <name since="">make_relup(Name, UpFrom, DownTo, [Opt]) -> Result</name>        <fsummary>Generates a release upgrade file <c>relup</c>.</fsummary>        <type>          <v>Name = string()</v> @@ -136,8 +136,8 @@      </func>      <func> -      <name>make_script(Name) -> Result</name> -      <name>make_script(Name, [Opt]) -> Result</name> +      <name since="">make_script(Name) -> Result</name> +      <name since="">make_script(Name, [Opt]) -> Result</name>        <fsummary>Generates a boot script <c>.script/.boot</c>.</fsummary>        <type>          <v>Name = string()</v> @@ -263,8 +263,8 @@      </func>      <func> -      <name>make_tar(Name) -> Result</name> -      <name>make_tar(Name, [Opt]) -> Result</name> +      <name since="">make_tar(Name) -> Result</name> +      <name since="">make_tar(Name, [Opt]) -> Result</name>        <fsummary>Creates a release package.</fsummary>        <type>          <v>Name = string()</v> @@ -369,7 +369,7 @@ myapp-1/ebin/myapp.app      </func>      <func> -      <name>script2boot(File) -> ok | error</name> +      <name since="">script2boot(File) -> ok | error</name>        <fsummary>Generates a binary version of a boot script.</fsummary>        <type>          <v>File = string()</v> | 
