add basic POD documentation

15 files changed, 357 insertions, 0 deletions

diff --git a/urpm/bug_report.pm b/urpm/bug_report.pm
index 137977d1..f7200a37 100644
--- a/urpm/bug_report.pm
+++ b/urpm/bug_report.pm
@@ -4,6 +4,18 @@ use strict;
 use urpm;
 use urpm::msg;
 
+=head1 NAME
+
+urpm::bug_report - Bug reporting routines for urpmi
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+=over
+
+=cut
+
 
 sub rpmdb_to_synthesis {
     my ($urpm, $synthesis) = @_;
@@ -58,3 +70,15 @@ sub copy_requested {
 }
 
 1;
+
+__END__
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright (C) 2005 MandrakeSoft SA
+
+Copyright (C) 2005-2010 Mandriva SA
+
+=cut
diff --git a/urpm/cdrom.pm b/urpm/cdrom.pm
index 9d7e185a..3c6d1f48 100644
--- a/urpm/cdrom.pm
+++ b/urpm/cdrom.pm
@@ -12,6 +12,19 @@ use urpm 'file_from_local_medium';
 
 
 
+=head1 NAME
+
+urpm::install - Package installation transactin routines for urpmi
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+=over
+
+=cut
+
+
 #- side-effects: $blists->[_]{medium}{mntpoint}
 sub _find_blist_matching {
     my ($urpm, $blists, $mntpoint) = @_;
@@ -236,3 +249,15 @@ sub copy_packages_of_removable_media {
 }
 
 1;
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright (C) 1999-2005 MandrakeSoft SA
+
+Copyright (C) 2005-2010 Mandriva SA
+
+Copyright (C) 2011-2012 Mageia
+
+=cut
diff --git a/urpm/get_pkgs.pm b/urpm/get_pkgs.pm
index bde604e8..f82b2e41 100644
--- a/urpm/get_pkgs.pm
+++ b/urpm/get_pkgs.pm
@@ -10,6 +10,19 @@ use urpm::media;
 use urpm 'file_from_local_url';
 # perl_checker: require urpm::select
 
+
+=head1 NAME
+
+urpm::get_pkgs - Package retrieving routines for urpmi
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+=over
+
+=cut 
+
 sub clean_all_cache {
     my ($urpm) = @_;
     #- clean download directory, do it here even if this is not the best moment.
@@ -284,3 +297,15 @@ sub _download_packages_of_distant_media {
 }
 
 1;
+
+__END__
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright (C) 2005 MandrakeSoft SA
+
+Copyright (C) 2005-2010 Mandriva SA
+
+=cut
diff --git a/urpm/install.pm b/urpm/install.pm
index 770d6ad9..741f9ee3 100644
--- a/urpm/install.pm
+++ b/urpm/install.pm
@@ -8,6 +8,18 @@ use urpm::msg;
 use urpm::util;
 
 
+=head1 NAME
+
+urpm::install - Package installation transactin routines for urpmi
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+=over
+
+=cut
+
 # size of the installation progress bar
 my $progress_size = 45;
 eval {
@@ -300,3 +312,15 @@ sub install {
 }
 
 1;
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright (C) 1999-2005 MandrakeSoft SA
+
+Copyright (C) 2005-2010 Mandriva SA
+
+Copyright (C) 2011-2012 Mageia
+
+=cut
diff --git a/urpm/lock.pm b/urpm/lock.pm
index 6139be7b..12ab7394 100644
--- a/urpm/lock.pm
+++ b/urpm/lock.pm
@@ -10,6 +10,20 @@ use urpm::util;
 my ($LOCK_SH, $LOCK_EX, $LOCK_NB, $LOCK_UN) = (1, 2, 4, 8);
 
 
+
+=head1 NAME
+
+urpm::lock - urpm/rpm DB locking related routines for urpmi
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+=over
+
+=cut 
+
+
 ################################################################################
 #- class functions
 
@@ -107,3 +121,14 @@ sub DESTROY {
     my ($lock) = @_;
     unlock($lock) if $lock->{fh};
 }
+__END__
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright (C) 2005 MandrakeSoft SA
+
+Copyright (C) 2005-2010 Mandriva SA
+
+=cut
diff --git a/urpm/main_loop.pm b/urpm/main_loop.pm
index 08ac11ca..e8bae71c 100644
--- a/urpm/main_loop.pm
+++ b/urpm/main_loop.pm
@@ -37,6 +37,19 @@ my ($auto_select, $no_install, $install_src, $clean, $noclean, $force, $parallel
 my ($ok, $nok);
 my $exit_code;
 
+
+=head1 NAME
+
+urpm::main_loop - The install/remove main loop for urpm based programs (urpmi, gurpmi, rpmdrake, drakx)
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+=over
+
+=cut
+
 sub _download_callback {
     my ($urpm, $callbacks, $raw_msg, $msg) = @_;
     if (my $download_errors = delete $urpm->{download_errors}) {
@@ -474,3 +487,15 @@ sub handle_need_restart {
 }
 
 1;
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright (C) 1999-2005 MandrakeSoft SA
+
+Copyright (C) 2005-2010 Mandriva SA
+
+Copyright (C) 2011-2012 Mageia
+
+=cut
diff --git a/urpm/md5sum.pm b/urpm/md5sum.pm
index 906066fe..8c1b7389 100644
--- a/urpm/md5sum.pm
+++ b/urpm/md5sum.pm
@@ -4,6 +4,19 @@ use strict;
 use urpm::util;
 use urpm::msg;
 
+
+=head1 NAME
+
+urpm::md5sum - Meta-data checking routines for urpmi
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+=over
+
+=cut 
+
 sub parse {
     my ($md5sum_file) = @_;
 
@@ -57,3 +70,15 @@ sub compute {
 }
 
 1;
+
+__END__
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright (C) 2005 MandrakeSoft SA
+
+Copyright (C) 2005-2010 Mandriva SA
+
+=cut
diff --git a/urpm/media.pm b/urpm/media.pm
index c8d3dcda..687e2c6d 100644
--- a/urpm/media.pm
+++ b/urpm/media.pm
@@ -48,6 +48,18 @@ my @media_info_prefix_suffix = (
     (map { [ $_, '.xml.lzma' ] } @xml_media_info),
 );
 
+=head1 NAME
+
+urpm::media - Media routines for urpmi
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+=over
+
+=cut 
+
 
 sub get_medium_option {
     my ($urpm, $medium, $option_name) = @_;
@@ -2048,3 +2060,15 @@ sub clean {
 }
 
 1;
+
+__END__
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright (C) 2005 MandrakeSoft SA
+
+Copyright (C) 2005-2010 Mandriva SA
+
+=cut
diff --git a/urpm/mirrors.pm b/urpm/mirrors.pm
index 8c258a0b..f3ef162b 100644
--- a/urpm/mirrors.pm
+++ b/urpm/mirrors.pm
@@ -8,6 +8,18 @@ use urpm::msg;
 use urpm::download;
 
 
+=head1 NAME
+
+urpm::mirrors - Mirrors routines for urpmi
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+=over
+
+=cut 
+
 #- $medium fields used: mirrorlist, with-dir
 #- side-effects: $medium->{url}
 #-   + those of _pick_one ($urpm->{mirrors_cache})
@@ -331,3 +343,15 @@ sub parse_LDAP_namespace_structure {
 }
 
 1;
+
+__END__
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright (C) 2005 MandrakeSoft SA
+
+Copyright (C) 2005-2010 Mandriva SA
+
+=cut
diff --git a/urpm/orphans.pm b/urpm/orphans.pm
index c3a7a234..c8e68b9e 100644
--- a/urpm/orphans.pm
+++ b/urpm/orphans.pm
@@ -9,6 +9,19 @@ use urpm;
 
 my $fullname2name_re = qr/^(.*)-[^\-]*-[^\-]*\.[^\.\-]*$/;
 
+
+=head1 NAME
+
+urpm::orphans - The orphan management code for urpmi
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+=over
+
+=cut
+
 #- side-effects: none
 sub installed_packages_packed {
     my ($urpm) = @_;
@@ -508,3 +521,15 @@ sub installed_leaves {
 }
 
 1;
+
+
+=back
+
+=head1 COPYRIGHT
+
+
+Copyright (C) 2008-2010 Mandriva SA
+
+Copyright (C) 2011-2012 Mageia
+
+=cut
diff --git a/urpm/removable.pm b/urpm/removable.pm
index 1fe9dd2b..a157d86b 100644
--- a/urpm/removable.pm
+++ b/urpm/removable.pm
@@ -10,6 +10,19 @@ use urpm 'file_from_local_medium';
 
 
 
+=head1 NAME
+
+urpm::removable - Removable media routines for urpmi
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+=over
+
+=cut 
+
+
 sub file_or_synthesis_dir {
     my ($medium, $o_url) = @_;
     
@@ -153,3 +166,15 @@ sub _blist_first_url {
 }
 
 1;
+
+__END__
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright (C) 2005 MandrakeSoft SA
+
+Copyright (C) 2005-2010 Mandriva SA
+
+=cut
diff --git a/urpm/select.pm b/urpm/select.pm
index d79785b1..8c352ccf 100644
--- a/urpm/select.pm
+++ b/urpm/select.pm
@@ -13,6 +13,20 @@ my @priority_list = split(',', $default_priority_list);
 
 my $evr_re = qr/[^\-]*-[^\-]*\.[^\.\-]*$/;
 
+
+=head1 NAME
+
+urpm::select - package selection routines for urpmi
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+=over
+
+=cut
+
+
 sub add_packages_to_priority_upgrade_list {
     @priority_list = uniq(@priority_list, @_);
 }
@@ -663,3 +677,7 @@ sub should_we_migrate_back_rpmdb_db_version {
 }
 
 1;
+
+=back
+
+=cut
diff --git a/urpm/signature.pm b/urpm/signature.pm
index 1f003e5b..931a95c2 100644
--- a/urpm/signature.pm
+++ b/urpm/signature.pm
@@ -8,6 +8,18 @@ use urpm::media;
 use urpm::util;
 
 
+=head1 NAME
+
+urpm::signature - Package signature routines for urpmi
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+=over
+
+=cut
+
 #- options: callback, basename
 sub check {
     my ($urpm, $sources_install, $sources, %options) = @_;
@@ -93,3 +105,15 @@ sub _check {
 }
 
 1;
+
+__END__
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright (C) 2005 MandrakeSoft SA
+
+Copyright (C) 2005-2010 Mandriva SA
+
+=cut
diff --git a/urpm/xml_info.pm b/urpm/xml_info.pm
index ca923ebc..bbd934dd 100644
--- a/urpm/xml_info.pm
+++ b/urpm/xml_info.pm
@@ -3,6 +3,18 @@ package urpm::xml_info;
 use strict;
 use XML::LibXML::Reader;
 
+=head1 NAME
+
+urpm::xml_info - XML data manipulation related routines for urpmi
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+=over
+
+=cut 
+
 # throw an exception on error
 sub get_nodes {
     my ($xml_info, $xml_info_file, $fullnames) = @_;
@@ -174,3 +186,13 @@ sub _iterate_on_nodes {
 
 1;
 
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright (C) 2005 MandrakeSoft SA
+
+Copyright (C) 2005-2010 Mandriva SA
+
+=cut
diff --git a/urpm/xml_info_pkg.pm b/urpm/xml_info_pkg.pm
index 94e96d07..d75bd2ce 100644
--- a/urpm/xml_info_pkg.pm
+++ b/urpm/xml_info_pkg.pm
@@ -2,6 +2,18 @@ package urpm::xml_info_pkg;
 
 use strict;
 
+=head1 NAME
+
+urpm::xml_info_pkg - XML Package data retrieving related routines for urpmi
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+=over
+
+=cut 
+
 # proxy object: returns the xml info if available, otherwise redirects to URPM::Package
 
 sub new {
@@ -46,3 +58,13 @@ sub filename { $_[0]{fn} . '.rpm' }
 
 
 1;
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright (C) 2005 MandrakeSoft SA
+
+Copyright (C) 2005-2010 Mandriva SA
+
+=cut