Changeset 391 in ProjectBuilder for devel/pb

Timestamp:

Apr 16, 2008, 3:24:40 PM (17 years ago)

Author:

Bruno Cornec

Message:

• pb: pod content for Distribution.pm and man page delivery
• dploy: improved pb setup in progress

Location:

devel/pb

Files:

• Makefile.PL (modified) (1 diff)
• lib/ProjectBuilder/Distribution.pm (modified) (7 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)', },
 );

devel/pb/lib/ProjectBuilder/Distribution.pm

@@ -19 +19 @@
 our @ISA = qw(Exporter);
 our @EXPORT = qw(pb_distro_init pb_get_distro);
+
+=pod
+
+=head1 NAME
+
+ProjectBuilder::Distribution, part of the project-builder.org - module dealing with distribution detection
+
+=head1 DESCRIPTION
+
+This modules provides functions to allow detection of Linux distributions, and giving back some attributes concerning them.
+
+=head1 SYNOPSIS
+
+  use ProjectBuilder::Distribution;
+
+  # 
+  # Return information on the running distro
+  #
+  my ($ddir, $dver, $dfam, $dtype, $pbsuf) = pb_distro_init();
+  print "distro tuple: ".Dumper($ddir, $dver, $dfam, $dtype, $pbsuf)."\n";
+  # 
+  # Return information on the requested distro
+  #
+  my ($ddir, $dver, $dfam, $dtype, $pbsuf) = pb_distro_init("ubuntu","7.10");
+  print "distro tuple: ".Dumper($ddir, $dver, $dfam, $dtype, $pbsuf)."\n";
+  # 
+  # Return information on the running distro
+  #
+  my ($ddir,$dver) = pb_get_distro();
+  my ($ddir, $dver, $dfam, $dtype, $pbsuf) = pb_distro_init($ddir,$dver);
+  print "distro tuple: ".Dumper($ddir, $dver, $dfam, $dtype, $pbsuf)."\n";
+
+=head1 USAGE
+
+=over 4
+
+=item B<pb_get_distro>
+
+This function returns a list of 2 parameters indicating the distribution name and version of the underlying Linux distribution. The value of those 2 fields may be "unknown" in case the function was unable to recognize on which distribution it is running.
+
+On my home machine it would currently report ("mandriva","2008.0").
+
+=item B<pb_distro_init>
+
+This function returns a list of 5 parameters indicating the distribution name, version, family, type of build system and suffix of packages of the underlying Linux distribution. The value of the 5 fields may be "unknown" in case the function was unable to recognize on which distribution it is running.
+
+As an example, Ubuntu and Debian are in the same "du" family. As well as RedHat, RHEL, CentOS, fedora are on the same "rh" family.
+Mandriva, Open SuSE and Fedora have all the same "rpm" type of build system. Ubuntu ad Debian have the same "deb" type of build system. 
+And "fc" is the extension generated for all Fedora packages (Version will be added by pb).
+
+When passing the distribution name and version as parameters, the B<pb_distro_init> function returns the parameter of that distribution instead of the underlying one.
+
+=back 
+
+=head1 WEB SITES
+
+The main Web site of the project is available at L<http://www.project-builder.org/>. Bug reports should be filled using the trac instance of the project at L<http://trac.project-builder.org/>.
+
+=head1 USER MAILING LIST
+
+None exists for the moment.
+
+=head1 AUTHORS
+
+The Project-Builder.org team L<http://trac.project-builder.org/> lead by Bruno Cornec L<mailto:bruno@project-builder.org>.
+
+=head1 COPYRIGHT
+
+Project-Builder.org is distributed under the GPL v2.0 license
+described in the file C<COPYING> included with the distribution.
+
+=cut
+
 
 sub pb_distro_init {
@@ -115 +188 @@
 # Tested
     'gentoo'            =>  'gentoo-release',       # >= 1.6
-    'debian'            =>  'debian_version',       # >= 3.1
     'slackware'         =>  'slackware-version',    # >= 10.2
     'mandriva'          =>  'mandriva-release',     # >=2006.0
@@ -153 +225 @@
 my %ambiguous_rel_files = (
     'mandrake'          =>  'mandrake-release',     # <= 10.1
+    'debian'            =>  'debian_version',       # >= 3.1
     'suse'              =>  'SuSE-release',         # >= 10.0
     'redhat'            =>  'redhat-release',       # >= 7.3
@@ -162 +235 @@
 my %distro_similar = (
     'mandrake'          => ['mandrake', 'mandrakelinux'],
+    'debian'            => ['debian', 'ubuntu'],
     'suse'              => ['suse', 'sles', 'opensuse'],
     'redhat'            => ['redhat', 'rhel', 'centos', 'mandrake', 'vmware'],
@@ -183 +257 @@
     'suse'                  => 'SUSE LINUX (\d.+) \(',
     'opensuse'              => 'openSUSE (\d.+) \(',
-    'debian'                => '(.+)',
     'lsb'                   => '.*[^Ubunt].*\nDISTRIB_RELEASE=(.+)',
 # Ubuntu 6.06 includes a /etc/debian_version file that needs to be 
@@ -190 +263 @@
 # Same is true for Ubuntu 7.10 :-(
     'ubuntu'                => '.*Ubuntu.*\nDISTRIB_RELEASE=(.+)',
+    'debian'                => '(.+)',
 # Not tested
     'arch'                  => '.* ([0-9.]+) .*',
@@ -198 +272 @@
 my $distro;
 
-# Begin to test presence of non-amiguous files
+# Begin to test presence of non-ambiguous files
 # that way we reduce the choice
 my ($d,$r);