From 50f64c60b87e8d03fedc3f9f4e655aff8ca9f16c Mon Sep 17 00:00:00 2001 From: Sverker Eriksson Date: Wed, 12 Dec 2018 19:32:24 +0100 Subject: Add empty 'since' attribute for old modules and functions --- lib/sasl/doc/src/alarm_handler.xml | 8 ++++---- lib/sasl/doc/src/rb.xml | 30 ++++++++++++++-------------- lib/sasl/doc/src/release_handler.xml | 38 ++++++++++++++++++------------------ lib/sasl/doc/src/systools.xml | 16 +++++++-------- 4 files changed, 46 insertions(+), 46 deletions(-) (limited to 'lib/sasl/doc') 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 @@ A alarm_handler.sgml.t1 - alarm_handler + alarm_handler An Alarm Handling Process

The alarm handler process is a @@ -81,7 +81,7 @@ - clear_alarm(AlarmId) -> void() + clear_alarm(AlarmId) -> void() Clears the specified alarms. AlarmId = term() @@ -94,7 +94,7 @@ - get_alarms() -> [alarm()] + get_alarms() -> [alarm()] Gets all active alarms.

Returns a list of all active alarms. This function can only @@ -103,7 +103,7 @@ - set_alarm(alarm()) + set_alarm(alarm()) Sets an alarm with an id. alarm() = {AlarmId, AlarmDescription} 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 @@ A rb.sgml - rb + rb The Report Browser Tool

The Report Browser (RB) tool is used to browse and @@ -86,7 +86,7 @@ - grep(RegExp) + grep(RegExp) Searches the reports for a regular expression. RegExp = string() | {string(), Options} | re:mp() | {re:mp(), Options} @@ -109,8 +109,8 @@ - h() - help() + h() + help() Displays help information.

Displays online help information.

@@ -118,8 +118,8 @@ - list() - list(Type) + list() + list(Type) Lists all reports. Type = type() @@ -157,8 +157,8 @@ - rescan() - rescan(Options) + rescan() + rescan(Options) Rescans the report directory. Options = [opt()] @@ -171,8 +171,8 @@ - show() - show(Report) + show() + show(Report) Displays reports. Report = integer() | type() @@ -186,8 +186,8 @@ - start() - start(Options) + start() + start(Options) Starts the rb_server. Options = [opt()] @@ -256,7 +256,7 @@ - start_log(FileName) + start_log(FileName) Redirects all output to FileName. FileName = string() | atom() | pid() @@ -268,7 +268,7 @@ - stop() + stop() Stops the rb_server.

Stops rb_server.

@@ -276,7 +276,7 @@ - stop_log() + stop_log() Stops logging to file.

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 @@ - release_handler + release_handler Unpacking and Installation of Release Packages

The release handler process belongs to the SASL @@ -168,7 +168,7 @@ - check_install_release(Vsn) -> {ok, OtherVsn, Descr} | {error, Reason} + check_install_release(Vsn) -> {ok, OtherVsn, Descr} | {error, Reason} check_install_release(Vsn,Opts) -> {ok, OtherVsn, Descr} | {error, Reason} Checks installation of a release in the system. @@ -202,7 +202,7 @@ - create_RELEASES(Root, RelDir, RelFile, AppDirs) -> ok | {error, Reason} + create_RELEASES(Root, RelDir, RelFile, AppDirs) -> ok | {error, Reason} Creates an initial RELEASES file. Root = RelDir = RelFile = string() @@ -233,7 +233,7 @@ - install_file(Vsn, File) -> ok | {error, Reason} + install_file(Vsn, File) -> ok | {error, Reason} Installs a release file in the release structure. Vsn = File = string() @@ -252,8 +252,8 @@ - install_release(Vsn) -> {ok, OtherVsn, Descr} | {error, Reason} - install_release(Vsn, [Opt]) -> {ok, OtherVsn, Descr} | {continue_after_restart, OtherVsn, Descr} | {error, Reason} + install_release(Vsn) -> {ok, OtherVsn, Descr} | {error, Reason} + install_release(Vsn, [Opt]) -> {ok, OtherVsn, Descr} | {continue_after_restart, OtherVsn, Descr} | {error, Reason} Installs a release in the system. Vsn = OtherVsn = string() @@ -383,7 +383,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - make_permanent(Vsn) -> ok | {error, Reason} + make_permanent(Vsn) -> ok | {error, Reason} Makes the specified release version permanent. Vsn = string() @@ -396,7 +396,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - remove_release(Vsn) -> ok | {error, Reason} + remove_release(Vsn) -> ok | {error, Reason} Removes a release from the system. Vsn = string() @@ -410,7 +410,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - reboot_old_release(Vsn) -> ok | {error, Reason} + reboot_old_release(Vsn) -> ok | {error, Reason} Reboots the system from an old release. Vsn = string() @@ -425,7 +425,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - set_removed(Vsn) -> ok | {error, Reason} + set_removed(Vsn) -> ok | {error, Reason} Marks a release as removed. Vsn = string() @@ -440,7 +440,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - set_unpacked(RelFile, AppDirs) -> {ok, Vsn} | {error, Reason} + set_unpacked(RelFile, AppDirs) -> {ok, Vsn} | {error, Reason} Marks a release as unpacked. RelFile = string() @@ -466,7 +466,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - unpack_release(Name) -> {ok, Vsn} | {error, Reason} + unpack_release(Name) -> {ok, Vsn} | {error, Reason} Unpacks a release package. Name = Vsn = string() @@ -482,7 +482,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - which_releases() -> [{Name, Vsn, Apps, Status}] + which_releases() -> [{Name, Vsn, Apps, Status}] Returns all known releases. Name = Vsn = string() @@ -537,7 +537,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - upgrade_app(App, Dir) -> {ok, Unpurged} | restart_emulator | {error, Reason} + upgrade_app(App, Dir) -> {ok, Unpurged} | restart_emulator | {error, Reason} Upgrades to a new application version. App = atom() @@ -586,8 +586,8 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - downgrade_app(App, Dir) -> - downgrade_app(App, OldVsn, Dir) -> {ok, Unpurged} | restart_emulator | {error, Reason} + downgrade_app(App, Dir) -> + downgrade_app(App, OldVsn, Dir) -> {ok, Unpurged} | restart_emulator | {error, Reason} Downgrades to a previous application version. App = atom() @@ -633,7 +633,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - upgrade_script(App, Dir) -> {ok, NewVsn, Script} + upgrade_script(App, Dir) -> {ok, NewVsn, Script} Finds an application upgrade script. App = atom() @@ -671,7 +671,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - downgrade_script(App, OldVsn, Dir) -> {ok, Script} + downgrade_script(App, OldVsn, Dir) -> {ok, Script} Finds an application downgrade script. App = atom() @@ -710,7 +710,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - eval_appup_script(App, ToVsn, ToDir, Script) -> {ok, Unpurged} | restart_emulator | {error, Reason} + eval_appup_script(App, ToVsn, ToDir, Script) -> {ok, Unpurged} | restart_emulator | {error, Reason} Evaluates an application upgrade or downgrade script. App = atom() 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 @@ - systools + systools A Set of Release Handling Tools

This module contains functions to generate boot scripts @@ -40,8 +40,8 @@ - make_relup(Name, UpFrom, DownTo) -> Result - make_relup(Name, UpFrom, DownTo, [Opt]) -> Result + make_relup(Name, UpFrom, DownTo) -> Result + make_relup(Name, UpFrom, DownTo, [Opt]) -> Result Generates a release upgrade file relup. Name = string() @@ -136,8 +136,8 @@ - make_script(Name) -> Result - make_script(Name, [Opt]) -> Result + make_script(Name) -> Result + make_script(Name, [Opt]) -> Result Generates a boot script .script/.boot. Name = string() @@ -263,8 +263,8 @@ - make_tar(Name) -> Result - make_tar(Name, [Opt]) -> Result + make_tar(Name) -> Result + make_tar(Name, [Opt]) -> Result Creates a release package. Name = string() @@ -369,7 +369,7 @@ myapp-1/ebin/myapp.app - script2boot(File) -> ok | error + script2boot(File) -> ok | error Generates a binary version of a boot script. File = string() -- cgit v1.2.3