aboutsummaryrefslogtreecommitdiffstats
path: root/lib/sasl/doc
diff options
context:
space:
mode:
authorjoewilliams <[email protected]>2011-10-18 10:30:56 -0700
committerHenrik Nord <[email protected]>2011-10-20 09:50:15 +0200
commit66be346a3b0f04bb010608ad6125ecec501384c2 (patch)
tree1dd3cb18a81fd5fa106e007fba0a951c55bb85ab /lib/sasl/doc
parent02ec67177b2f5d2de371362e5bb3c9b9771fb0b8 (diff)
downloadotp-66be346a3b0f04bb010608ad6125ecec501384c2.tar.gz
otp-66be346a3b0f04bb010608ad6125ecec501384c2.tar.bz2
otp-66be346a3b0f04bb010608ad6125ecec501384c2.zip
Add release_handler:which_releases/1
This is an extension to which_releases that allows a user to specify the status of the releases they wish to be returned. For instance it allows for quickly determining which release is 'permanent' without the need of parsing the entire release list.
Diffstat (limited to 'lib/sasl/doc')
-rw-r--r--lib/sasl/doc/src/release_handler.xml12
1 files changed, 12 insertions, 0 deletions
diff --git a/lib/sasl/doc/src/release_handler.xml b/lib/sasl/doc/src/release_handler.xml
index 5ac0dc1acc..cf05b1a67d 100644
--- a/lib/sasl/doc/src/release_handler.xml
+++ b/lib/sasl/doc/src/release_handler.xml
@@ -431,6 +431,18 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]).
<p>Returns all releases known to the release handler.</p>
</desc>
</func>
+ <func>
+ <name>which_releases(Status) -> [{Name, Vsn, Apps, Status}]</name>
+ <fsummary>Return all known releases of a specific status</fsummary>
+ <type>
+ <v>Name = Vsn = string()</v>
+ <v>Apps = ["App-Vsn"]</v>
+ <v>Status = unpacked | current | permanent | old</v>
+ </type>
+ <desc>
+ <p>Returns all releases known to the release handler of a specific status.</p>
+ </desc>
+ </func>
</funcs>
<section>