Changeset 1023 for trunk/LATMOS-Accounts/lib/LATMOS/Accounts/Utils.pm

Timestamp:

05/29/12 10:25:51 (12 years ago)

Author:

nanardon

Message:

• complete POD

This patch a basic documentation to all functions.
It also add two test to ensure all POD syntax are correct and coverage is full.

File:

• trunk/LATMOS-Accounts/lib/LATMOS/Accounts/Utils.pm (modified) (9 diffs)

trunk/LATMOS-Accounts/lib/LATMOS/Accounts/Utils.pm

@@ -11 +11 @@
 our $VERSION = (q$Rev$ =~ /^Rev: (\d+) /)[0];
 
+=head1 NAME
+
+LATMOS::Accounts::Utils - Utils functions
+
+=head1 FUNCTIONS
+
+=cut
+
 @ISA = qw(Exporter);
 @EXPORT = qw(to_ascii exec_command switch_user run_via_sudo);
 @EXPORT_OK = qw(to_ascii exec_command switch_user run_via_sudo);
+
+=head2 to_ascii($text)
+
+Replace in C<$text> non ascii caracters from iso-8859-15 table to ascii
+equivalent caracter.
+
+=cut
 
 sub to_ascii {
@@ -26 +41 @@
     $text
 } 
+
+=head2 exec_command($command, $env)
+
+Execute C<$command> and redirect output to log system.
+
+C<$env> is a hashref containing environment variable to set, all variables are
+prefixed by 'LA_'.
+
+=cut
 
 sub exec_command {
@@ -80 +104 @@
 }
 
+=head2 parse_obj_file($handle)
+
+Read file content from C<$handle> and return hash containing parsed attributes
+
+=cut
+
 sub parse_obj_file {
     my ($handle) = @_;
@@ -107 +137 @@
 }
 
+=head2 dump_read_temp_file($writecb, $readcb)
+
+Create a temporary file, call C<$writecb()> function, run editor and if file get
+modified call C<$readcb>.
+
+=cut
+
 sub dump_read_temp_file {
     my ($writecb, $readcb) = @_;
@@ -137 +174 @@
 }
 
+=head2 check_oid_validity($name)
+
+Check C<$name> is suitable to be used as object identifier. Return the error
+text, undef if no error.
+
+=cut
+
 sub check_oid_validity {
     my ($name) = @_;
@@ -145 +189 @@
     return;
 }
+
+=head2 check_ug_validity($name)
+
+Check C<$name> is suitable to used as user or group identifier.
+
+=cut
 
 sub check_ug_validity {
@@ -157 +207 @@
     return check_oid_validity($name);
 }
+
+=head2 switch_user($runas)
+
+Switch effective id of the process to user named C<$runas>
+
+=cut
 
 sub switch_user {
@@ -173 +229 @@
 }
 
+=head2 run_via_sudo($runas)
+
+Rerun current programme as C<$runas> user using sudo
+
+=cut
+
 sub run_via_sudo {
     my ($runas) = @_;
@@ -186 +248 @@
 
 1;
+
+__END__
+
+=head1 SEE ALSO
+
+L<sudo>
+
+=head1 AUTHOR
+
+Olivier Thauvin, E<lt>olivier.thauvin@aerov.jussieu.frE<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright (C) 2008, 2009, 2010, 2011, 2012 CNRS SA/CETP/LATMOS
+
+This library is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself, either Perl version 5.10.0 or,
+at your option, any later version of Perl 5 you may have available.
+
+=cut