From cacb329cadd72547cb886b0b785c3cc16e4aa590 Mon Sep 17 00:00:00 2001
From: Thierry Vignaud <tv@mageia.org>
Date: Fri, 31 Aug 2012 16:45:07 +0000
Subject: split POD documentation

---
 urpm/download.pm | 18 +++++++-------
 urpm/ldap.pm     | 71 +++++++++++++++++++++++++++++++++++---------------------
 urpm/sys.pm      | 20 ++++++++++------
 3 files changed, 67 insertions(+), 42 deletions(-)

(limited to 'urpm')

diff --git a/urpm/download.pm b/urpm/download.pm
index 97187270..a493bde3 100644
--- a/urpm/download.pm
+++ b/urpm/download.pm
@@ -27,6 +27,16 @@ my $proxy_config;
 our $CONNECT_TIMEOUT = 60; #-  (in seconds)
 
 
+=head1 NAME
+
+urpm::download - download routines for the urpm* tools
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+=cut
+
 
 sub ftp_http_downloaders() { qw(curl wget prozilla aria2) }
 
@@ -1059,14 +1069,6 @@ sub _create_metalink_ {
 
 __END__
 
-=head1 NAME
-
-urpm::download - download routines for the urpm* tools
-
-=head1 SYNOPSIS
-
-=head1 DESCRIPTION
-
 =head1 COPYRIGHT
 
 Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005 MandrakeSoft SA
diff --git a/urpm/ldap.pm b/urpm/ldap.pm
index 79ee9100..50c95962 100644
--- a/urpm/ldap.pm
+++ b/urpm/ldap.pm
@@ -34,33 +34,6 @@ Writes the value fetched from ldap, in case of server failure. This should not
 be used to reduce the load of the ldap server, as fetching is still needed, and
 therefore, caching is useless if server is up.
 
-=item check_ldap_medium($medium)
-
-Checks if the ldap medium has all required attributes.
-
-=item read_ldap_cache($urpm)
-
-Reads the cache created by the C<write_ldap_cache> function. Should be called
-if the ldap server doesn't answer (upgrade, network problem, mobile user, etc.)
-
-=item clean_ldap_cache($urpm)
-
-Cleans the ldap cache, removes all files in the directory.
-
-=item load_ldap_media($urpm)
-
-Loads urpmi media configuration from ldap.
-
-=item get_ldap_config()
-
-=item get_ldap_config_file($file)
-
-=item get_ldap_config_dns()
-
-Not implemented yet.
-
-=back
-
 =cut
 
 sub write_ldap_cache($$) {
@@ -80,6 +53,13 @@ sub write_ldap_cache($$) {
     return 1;
 }
 
+
+=item check_ldap_medium($medium)
+
+Checks if the ldap medium has all required attributes.
+
+=cut
+
 sub check_ldap_medium($) {
     my ($medium) = @_;
     return $medium->{name} && $medium->{url};
@@ -97,6 +77,13 @@ sub get_vars_from_sh {
     %l;
 }
 
+=item read_ldap_cache($urpm)
+
+Reads the cache created by the C<write_ldap_cache> function. Should be called
+if the ldap server doesn't answer (upgrade, network problem, mobile user, etc.)
+
+=cut
+
 sub read_ldap_cache {
     my ($urpm) = @_;
     foreach (glob("$urpm->{cachedir}/ldap/*")) {
@@ -107,16 +94,31 @@ sub read_ldap_cache {
     }
 }
 
+=item clean_ldap_cache($urpm)
+
+Cleans the ldap cache, removes all files in the directory.
+
+=cut
+
 #- clean the cache, before writing a new one
 sub clean_ldap_cache($) {
     my ($urpm) = @_;
     unlink glob("$urpm->{cachedir}/ldap/*");
 }
 
+
+=item get_ldap_config()
+
+=cut
+
 sub get_ldap_config() {
     return get_ldap_config_file($LDAP_CONFIG_FILE);
 }
 
+=item get_ldap_config_file($file)
+
+=cut
+
 sub get_ldap_config_file {
     my ($file) = @_;
     my %config;
@@ -132,6 +134,13 @@ sub get_ldap_config_file {
     return %config && \%config;
 }
 
+
+=item get_ldap_config_dns()
+
+Not implemented yet.
+
+=cut
+
 sub get_ldap_config_dns() {
     # TODO
     die "not implemented yet\n";
@@ -145,6 +154,12 @@ my %ldap_changed_attributes = (
     'media-info-dir' => 'media_info_dir',
 );
 
+=item load_ldap_media($urpm)
+
+Loads urpmi media configuration from ldap.
+
+=cut
+
 sub load_ldap_media {
     my ($urpm) = @_;
 
@@ -220,6 +235,8 @@ sub load_ldap_media {
 
 __END__
 
+=back
+
 =head1 COPYRIGHT
 
 Copyright (C) 2005 MandrakeSoft SA
diff --git a/urpm/sys.pm b/urpm/sys.pm
index 0bdad0d2..e615b215 100644
--- a/urpm/sys.pm
+++ b/urpm/sys.pm
@@ -11,6 +11,18 @@ use POSIX ();
 (our $VERSION) = q($Revision: 271299 $) =~ /(\d+)/;
 
 
+=head1 NAME
+
+urpm::sys - OS-related routines for urpmi
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+=over
+
+=cut 
+
 #- get the list of packages that should not be upgraded or installed,
 #- typically from the inst.list or skip.list files.
 sub get_packages_list {
@@ -369,13 +381,7 @@ sub move_or_die {
 
 __END__
 
-=head1 NAME
-
-urpm::sys - OS-related routines for urpmi
-
-=head1 SYNOPSIS
-
-=head1 DESCRIPTION
+=back
 
 =head1 COPYRIGHT
 
-- 
cgit v1.2.1