X-Git-Url: https://vcs.fsf.org/?p=exim.git;a=blobdiff_plain;f=test%2Flib%2FExim%2FRuntest.pm;h=845388b8b268cb172e17b0582ebd7fa3d97dad03;hp=1df2ea1a9b7ea8bafcfee15593e96bd3c1504d4a;hb=b1227303735a346c79fd0734c9efb5d13609ad55;hpb=b369d47038a075706f6dfe57ab2e1ebeea0e5bdf

diff --git a/test/lib/Exim/Runtest.pm b/test/lib/Exim/Runtest.pm
index 1df2ea1a9..845388b8b 100644
--- a/test/lib/Exim/Runtest.pm
+++ b/test/lib/Exim/Runtest.pm
@@ -6,12 +6,24 @@ use Carp;
 
 use List::Util qw'shuffle';
 
+=head1 NAME
+
+Exim::Runtest - helper functions for the runtest script
+
+=head1 SYNOPSIS
+
+ use Exim::Runtest;
+ my $foo = Exim::Runtest::foo('foo');
+
+=head1 DESCRIPTION
+
+The B<Exim::Runtest> module provides some simple functions
+for the F<runtest> script. No functions are exported yet.
+
+=cut
 
-# find a group name, preferrable 'mail', but
-# use some other random name if 'mail' isn't a valid group
-# name
 sub mailgroup {
-    my $group = shift;
+    my $group = shift // croak "Need a default group name.";
 
     croak "Need a group *name*, not a numeric group id."
         if $group =~ /^\d+$/;
@@ -39,3 +51,23 @@ sub dynamic_socket {
 }
 
 1;
+
+__END__
+
+=head1 FUNCTIONS
+
+=over
+
+=item B<mailgroup>(I<$default>)
+
+Check if the mailgroup I<$default> exists. Return the checked
+group name or some other random but existing group.
+
+=item B<dynamic_socket>()
+
+Return a dynamically allocated listener socket in the range
+between 1024 and 65534;
+
+=back
+
+=cut