(run) document it

1 files changed, 88 insertions, 0 deletions

diff --git a/urpm/main_loop.pm b/urpm/main_loop.pm
index 656950da..66b211b3 100644
--- a/urpm/main_loop.pm
+++ b/urpm/main_loop.pm
@@ -345,6 +345,94 @@ Run the main urpm loop:
 
 Warning: locking is left to callers...
 
+Parameters:
+
+=over
+
+=item $urpm: the urpm object
+
+=item $state: the state object (see L<URPM>)
+
+=item $something_was_to_be_done
+
+=item $ask_unselect: an array ref of packages that could not be selected
+
+=item $callbacks: a hash ref of callbacks :
+
+=over
+
+=item trans_log: called for displaying download progress
+
+=item interaction with user:
+
+=over
+
+=item ask_yes_or_no($_title, $msg)
+
+=item need_restart($need_restart_formatted) called when restarting urpmi is needed (priority upgrades)
+
+=item message($_title, $msg): display a message (with a title for GUIes)
+
+=back
+
+=item signature management:
+
+=over
+
+=item pre_check_sig(): signature checking startup (for rpmdrake)
+
+=item check_sig(): signature checking progress (for rpmdrake)
+
+=item bad_signature($msg, $msg2): called when a package is not/badly signed
+
+=back
+
+=item removable media management:
+
+=over
+
+=item pre_removable(): called before handling removable media (for rpmdrake)
+
+=item copy_removable($medium_name): called for asking inserting a CD/DVD
+
+=item post_extract($set, $transaction_sources, $transaction_sources_install) called after handling removable media (for rpmdrake)
+
+=back
+
+=item packages installation callbacks (passed to urpm::install::install())
+
+=over
+
+=item open_helper(): called when opening a package, must return a fd
+
+=item close_helper(): called when package is closed
+
+=item inst() called for package opening/progress/end
+
+=item trans() called for transaction opening/progress/end
+
+=item callback_report_uninst(): called for erasure progrses
+
+=back
+
+=item finish callbacks (mainly GUI callbacks for rpmdrake/gurpmi/drakx)
+
+=over
+
+=item completed(): called when everything is completed (for cleanups)
+
+=item trans_error_summary($nok, $errors) called to warn than $nok transactions failed with $errors messages
+
+=item success_summary() called on success
+
+=item already_installed_or_not_installable($msg1, $msg2)
+
+=back
+
+=back
+
+=back
+
 =cut