From 636050ee4ff15248e2f9a1900b99426957310343 Mon Sep 17 00:00:00 2001
From: Thierry Vignaud <thierry.vignaud@gmail.com>
Date: Fri, 28 Aug 2015 10:17:45 -0400
Subject: describe a cople more functions

---
 urpm/orphans.pm | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)

(limited to 'urpm/orphans.pm')

diff --git a/urpm/orphans.pm b/urpm/orphans.pm
index 5ba1656f..9b204bfc 100644
--- a/urpm/orphans.pm
+++ b/urpm/orphans.pm
@@ -49,6 +49,12 @@ sub unrequested_list__file {
     ($urpm->{env_dir} || "$urpm->{root}/var/lib/rpm") . '/installed-through-deps.list';
 }
 
+=item unrequested_list($urpm)
+
+Returns the list of potentiel files (ake files installed as requires for others)
+
+=cut
+
 #- side-effects: none
 sub unrequested_list {
     my ($urpm) = @_;
@@ -89,6 +95,20 @@ sub mark_as_requested {
     }
 }
 
+=item _installed_req_and_unreq($urpm)
+
+Returns :
+
+=over
+
+=item * req: list of installed packages that were installed as requires of others 
+
+=item * unreq: list of installed packages that were not installed as requres of others (ie the ones that were explicitely selected for install)
+
+=back
+
+=cut
+
 #- side-effects:
 #-   + those of _installed_req_and_unreq_and_update_unrequested_list (<root>/var/lib/rpm/installed-through-deps.list)
 sub _installed_req_and_unreq {
@@ -97,6 +117,20 @@ sub _installed_req_and_unreq {
     ($req, $unreq);
 }
 
+=item _installed_and_unrequested_lists($urpm)
+
+Returns :
+
+=over
+
+=item * pkgs: list of installed packages
+
+=item * unrequested: list of packages that were installed as requires of others (the sum of the previous lists)
+
+=back
+
+=cut
+
 #- side-effects:
 #-   + those of _installed_req_and_unreq_and_update_unrequested_list (<root>/var/lib/rpm/installed-through-deps.list)
 sub _installed_and_unrequested_lists {
@@ -118,6 +152,22 @@ sub _write_unrequested_list__file {
 		".old") if !$urpm->{env_dir};
 }
 
+=item _installed_req_and_unreq_and_update_unrequested_list ($urpm)
+
+Returns :
+
+=over
+
+=item * req: list of installed packages that were installed as requires of others 
+
+=item * unreq: list of installed packages that were not installed as requres of others (ie the ones that were explicitely selected for install)
+
+=item * unrequested: list of packages that were installed as requires of others (the sum of the previous lists)
+
+=back
+
+=cut
+
 #- side-effects: those of _write_unrequested_list__file
 sub _installed_req_and_unreq_and_update_unrequested_list {
     my ($urpm) = @_;
-- 
cgit v1.2.1