From 66be346a3b0f04bb010608ad6125ecec501384c2 Mon Sep 17 00:00:00 2001
From: joewilliams <joe@joetify.com>
Date: Tue, 18 Oct 2011 10:30:56 -0700
Subject: 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.
---
 lib/sasl/doc/src/release_handler.xml | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'lib/sasl/doc/src')

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>
-- 
cgit v1.2.3