Changeset 396 in ProjectBuilder for devel/pb

Timestamp:

Apr 19, 2008, 12:46:44 AM (17 years ago)

Author:

Bruno Cornec

Message:

• pod doc done for Base.pm, and man page generated now for it

Location:

devel/pb

Files:

• Makefile.PL (modified) (1 diff)
• lib/ProjectBuilder/Base.pm (modified) (9 diffs)

devel/pb/Makefile.PL

@@ -18 +18 @@
     EXE_FILES     => [ qw( bin/pb bin/pbg bin/pbvi bin/pbdistrocheck ) ],
     MAN1PODS      => { 'bin/pb' => '$(INST_MAN1DIR)/pb.$(MAN1EXT)', },
-    MAN3PODS      => { 'lib/ProjectBuilder/Distribution.pm' => '$(INST_MAN3DIR)/ProjectBuilder::Distribution.$(MAN3EXT)', },
+    MAN3PODS      => {  'lib/ProjectBuilder/Distribution.pm' => '$(INST_MAN3DIR)/ProjectBuilder::Distribution.$(MAN3EXT)',
+                        'lib/ProjectBuilder/Base.pm' => '$(INST_MAN3DIR)/ProjectBuilder::Base.$(MAN3EXT)', },
 );

devel/pb/lib/ProjectBuilder/Base.pm

@@ -97 +97 @@
 
 Internal mkdir -p function. Forces mode to 755. Supports multiple parameters.
-Based in File::Path mkpath.
+
+Based on File::Path mkpath.
 
 =cut
@@ -107 +108 @@
 }
 
-=item B<pb_mkdir_p>
+=item B<pb_rm_rf>
 
 Internal rm -rf function. Supports multiple parameters.
-Based in File::Path rmtree.
+
+Based on File::Path rmtree.
 
 =cut
@@ -129 +131 @@
 The second parameter is the message to print on screen. If none is given, then the command is printed.
 This function returns the result the return value of the system command.
+
 If no error reported, it prints OK on the screen, just after the message. Else it prints the errors generated.
 
@@ -169 +172 @@
 Supposing the file is called "$ENV{'HOME'}/.pbrc", containing the following:
 
-$ cat $HOME/.pbrc
-pbver pb = 3
-pbver default = 1
-pblist pb = 12,25
+  $ cat $HOME/.pbrc
+  pbver pb = 3
+  pbver default = 1
+  pblist pb = 12,25
 
 calling it like this:
 
-my ($k1, $k2) = pb_conf_read_if("$ENV{'HOME'}/.pbrc","pbver","pblist");
-
-will allow to get the mapping 
-$k1->{'pb'}  contains 3
-$ka->{'default'} contains 1
-$k2->{'pb'} contains 12,25
+  my ($k1, $k2) = pb_conf_read_if("$ENV{'HOME'}/.pbrc","pbver","pblist");
+
+will allow to get the mapping:
+
+  $k1->{'pb'}  contains 3
+  $ka->{'default'} contains 1
+  $k2->{'pb'} contains 12,25
 
 Valid chars for keys and tags are letters, numbers, '-' and '_'.
@@ -231 +235 @@
 
 A URI has the format protocol://[ac@]host[:port][path[?query][#fragment]].
+
 Cf man URI.
 
@@ -275 +280 @@
 The second parameter is a pointer on a file descriptor used to print the log info.
 
+As an example, if you set the debug level to 2 in that function, every call to pb_log which contains a value less or equal than 2 will be printed. Calls with a value greater than 2 won't be printed.
+
+The call to B<pb_log_init> is typically done after getting a parameter on the CLI indicating the level of verbosity expected.
+
 =cut
 
@@ -284 +293 @@
 } 
 
+=item B<pb_log>
+
+This function logs the messages passed as the second parameter if the value passed as first parameter is lesser or equal than the value passed to the B<pb_log_init> function.
+
+Here is a usage example:
+
+  pb_log_init(2,\*STDERR);
+  pb_log(1,"Hello World 1\n");
+  pb_log(2,"Hello World 2\n");
+  pb_log(3,"Hello World 3\n");
+
+  will print:
+  
+  Hello World 1
+  Hello World 2
+
+=cut 
+
 sub pb_log {
 
@@ -292 +319 @@
 }
 
-# cat equivalent function
+=item B<pb_display_file>
+
+This function print the content of the file passed in parameter.
+
+This is a cat equivalent function.
+
+=cut
+
 sub pb_display_file {
 
@@ -300 +334 @@
 printf "%s\n",pb_get_content($file);
 }
+
+=item B<pb_get_content>
+
+This function returns the content of the file passed in parameter.
+
+=cut
 
 # get content of a file in a variable