From 3cd85172bf689b679e8c1fc626690ba87b136d74 Mon Sep 17 00:00:00 2001
From: Thierry Vignaud <tv@mageia.org>
Date: Fri, 31 Aug 2012 16:45:13 +0000
Subject: document some functions

---
 urpm/md5sum.pm | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

(limited to 'urpm/md5sum.pm')

diff --git a/urpm/md5sum.pm b/urpm/md5sum.pm
index 8c1b7389..62a21512 100644
--- a/urpm/md5sum.pm
+++ b/urpm/md5sum.pm
@@ -17,6 +17,14 @@ urpm::md5sum - Meta-data checking routines for urpmi
 
 =cut 
 
+
+=item parse($md5sum_file)
+
+Parse a MD5SUM file.
+Returns a hash of file => md5sum 
+
+=cut
+
 sub parse {
     my ($md5sum_file) = @_;
 
@@ -28,6 +36,14 @@ sub parse {
     \%h;
 }
 
+
+=item parse($md5sum_file)
+
+Check size and parse a MD5SUM file.
+Returns a hash of file => md5sum 
+
+=cut
+
 sub check_file {
     my ($md5sum_file) = @_;
 
@@ -40,6 +56,13 @@ sub from_MD5SUM__or_warn {
     $md5sums->{$basename};
 }
 
+
+=item versioned_media_info_file($urpm, $medium, $basename)
+
+Returns the latest versionated file name for $basename
+
+=cut
+
 sub versioned_media_info_file {
     my ($urpm, $medium, $basename) = @_;
     my $md5sums = $medium->{parsed_md5sum} or $urpm->{log}("$medium->{name} has no md5sum"), return;
@@ -54,6 +77,12 @@ sub versioned_media_info_file {
     $l[0];
 }
 
+=item compute($file)
+
+Return the MD5SUM control sum of $file
+
+=cut
+
 sub compute {
     my ($file) = @_;
     eval { require Digest::MD5 };
-- 
cgit v1.2.1