From 8546de8988c5e203a6cf089609b862007b337604 Mon Sep 17 00:00:00 2001
From: Thierry Vignaud <tv@mageia.org>
Date: Sun, 20 Jan 2013 21:08:12 +0000
Subject: document traverse_db*() return values

---
 URPM.pm | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'URPM.pm')

diff --git a/URPM.pm b/URPM.pm
index b9d1920..b3e223d 100644
--- a/URPM.pm
+++ b/URPM.pm
@@ -457,6 +457,8 @@ Rebuilds the RPM database (like C<rpm --rebuilddb>). $prefix defaults to C<"">.
 Executes the specified callback (a code reference) for each package
 in the DB, passing a C<URPM::Package> object as argument the callback.
 
+Returns the number of packages seen (all).
+
 =item $db->traverse_tag($tag,$names,$callback)
 
 $tag may be one of C<name>, C<whatprovides>, C<whatrequires>, C<whatconflicts>,
@@ -465,12 +467,16 @@ $names is a reference to an array, holding the acceptable values of the said
 tag for the searched variables.
 Then, $callback is called for each matching package in the DB.
 
+Returns the number of packages seen (all those that matched provided names).
+
 =item $db->traverse_tag_find($tag,$name,$callback)
 
 Quite similar to C<traverse_tag>, but stops when $callback returns true.
 
 (also note that only one $name is handled)
 
+Returns whether callback returned true once.
+
 =item $db->create_transaction()
 
 Creates and returns a new transaction (an C<URPM::Transaction> object) on the
-- 
cgit v1.2.1