From 46254a55eced8372d55b4e2635561d7e94adc8a5 Mon Sep 17 00:00:00 2001
From: Pascal Rigaux <pixel@mandriva.com>
Date: Tue, 11 Sep 2007 08:44:40 +0000
Subject: move doc where it belongs

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

(limited to 'URPM.pm')

diff --git a/URPM.pm b/URPM.pm
index b3d4b66..8fed007 100644
--- a/URPM.pm
+++ b/URPM.pm
@@ -780,6 +780,45 @@ lower is prefered.
 
 =back
 
+=head2 The $state object
+
+It has the following fields:
+
+B<backtrack>: { 
+   selected => { id => undef }, 
+   deadlock => { id|property => undef },
+ }
+
+B<cached_installed>: { property_name => { fullname => undef } }
+
+B<oldpackage>: int
+   # will be passed to $trans->run to set RPMPROB_FILTER_OLDPACKAGE
+
+B<selected>: { id => { 
+     requested => bool, install => bool,
+     from => pkg, psel => pkg,
+     promote => name, unsatisfied => [ id|property ]
+ } }
+
+B<rejected>: { fullname => { 
+     size => int, removed => bool, obsoleted => bool,
+     backtrack => { 
+         promote => [ name ], keep => [ fullname ], 
+         unsatisfied => [ id|property ], 
+         closure => { fullname => { old_requested => bool, 
+                                    unsatisfied => [ id|property ] } },
+     },
+ } }
+
+B<whatrequires>: { name => { id => undef } }
+   # reversed requires_nosense for selected packages
+
+more fields only used in build_transaction_set and its callers):
+
+B<transaction>: [ { upgrade => [ id ], remove => [ fullname ] } ]
+
+B<transaction_state>: $state object
+
 =head1 COPYRIGHT
 
 Copyright 2002, 2003, 2004, 2005 MandrakeSoft SA
-- 
cgit v1.2.1