aboutsummaryrefslogtreecommitdiffstats
path: root/lib/reltool/doc
diff options
context:
space:
mode:
authorHåkan Mattsson <[email protected]>2010-03-09 18:46:31 +0100
committerHåkan Mattsson <[email protected]>2010-04-19 13:17:32 +0200
commit512b1a258c083021f199e6cad2da479e7fdfd6dd (patch)
tree7d2fc07d031daa0032eff26c12085a0c4339ca66 /lib/reltool/doc
parent2846d03cb026ec9f33ea32747b4a231e1239b1ae (diff)
downloadotp-512b1a258c083021f199e6cad2da479e7fdfd6dd.tar.gz
otp-512b1a258c083021f199e6cad2da479e7fdfd6dd.tar.bz2
otp-512b1a258c083021f199e6cad2da479e7fdfd6dd.zip
Add function to return status about the configuration
It is called reltool:get_status/1. The API functions in reltool that may take PidOrOptions as input and actually gets Options does now print out the warnings.
Diffstat (limited to 'lib/reltool/doc')
-rw-r--r--lib/reltool/doc/src/reltool.xml11
1 files changed, 11 insertions, 0 deletions
diff --git a/lib/reltool/doc/src/reltool.xml b/lib/reltool/doc/src/reltool.xml
index 15beec52d6..24683b9302 100644
--- a/lib/reltool/doc/src/reltool.xml
+++ b/lib/reltool/doc/src/reltool.xml
@@ -618,6 +618,17 @@ target_spec() = [target_spec()]
</func>
<func>
+ <name>get_status(Server) -> {ok, [Warning]} | {error, Reason}</name>
+ <fsummary>Get contents of a release file</fsummary>
+ <type>
+ <v>Server = server()</v>
+ <v>Warning = string()</v>
+ <v>Reason = reason()</v>
+ </type>
+ <desc><p>Get status about the configuration</p></desc>
+ </func>
+
+ <func>
<name>get_server(WindowPid) -> {ok, ServerPid} | {error, Reason}</name>
<fsummary>Start server process with options</fsummary>
<type>