Changeset 409 in ProjectBuilder for devel/pb/lib/ProjectBuilder/Filter.pm

Timestamp:

Apr 25, 2008, 3:13:55 PM (16 years ago)

Author:

Bruno Cornec

Message:

• Document all reusable functions in pb
• remove the useless pbproj parameter from pb_filter functions
• Addition and use of pb_conf_init and pb_conf_add in pb
• Addition and use of pb_conf_fromfile_if in Conf.pm
• preparation for 0.9.1
• Update of pbinit files for mondo to support the new interface of pb_filter functions

File:

• devel/pb/lib/ProjectBuilder/Filter.pm (modified) (8 diffs)

devel/pb/lib/ProjectBuilder/Filter.pm

@@ -35 +35 @@
 =head1 NAME
 
-ProjectBuilder::Base, part of the project-builder.org - module dealing with generic functions suitable for perl project development
+ProjectBuilder::Filter, part of the project-builder.org
 
 =head1 DESCRIPTION
 
-pb helps you build various packages directly from your project sources. 
-Those sources could be handled by a CMS (Configuration Management System)
-such as Subversion, CVS, ... or being a simple reference to a compressed tar file.
-It's based on a set of configuration files, a set of provided macros to help 
-you keeping build files as generic as possible. For example, a single .spec
-file should be required to generate for all rpm based distributions, even 
-if you could also have multiple .spec files if required.
-
-=cut
-
-# Get all filters to apply
-# They're cumulative from less specific to most specific
-# suffix is .pbf
+This module provides filtering functions suitable for pbinit calls.
+
+=item B<pb_get_filters>
+
+This function gets all filters to apply. They're cumulative from the less specific to the most specific.
+
+Suffix of those filters is .pbf. Filter all.pbf applies to whatever distribution. The pbfilter directory may be global under pbconf or per package, for overloading values. Then in order filters are loaded for distribution type, distribution family, distribution name, distribution name-version.
+
+The first parameter is the package name.
+The second parameter is the distribution type.
+The third parameter is the distribution family.
+The fourth parameter is the distribution name.
+The fifth parameter is the distribution version.
+
+The function returns a pointer on a hash of filters.
+
+=cut
 
 sub pb_get_filters {
@@ -113 +117 @@
 }
 
-# Function which applies filter on pb build files
+=item B<pb_filter_file_pb>
+
+This function applies all filters to pb build files.
+
+It takes 15 parameters.
+
+The first parameter is the file to filter.
+The second parameter is the pointer on the hash of filters.
+The third parameter is the destination file after filtering.
+The fourth parameter is the distribution type.
+The fifth parameter is the suffix of the distribution.
+The sixth parameter is the package name.
+The seventh parameter is the version of the package.
+The eighth parameter is the tag of the package.
+The nineth parameter is the revision of the package.
+The tenth parameter is the current date.
+The eleventh parameter is the list of required packages.
+The twelveth parameter is the list of optional packages.
+The thirteenth parameter is the packager name.
+The fourteenth parameter is the changelog.
+
+=cut
+
 sub pb_filter_file_pb {
 
@@ -122 +148 @@
 my $dtype=shift;
 my $pbsuf=shift;
-my $pbproj=shift;
 my $pbpkg=shift;
 my $pbver=shift;
@@ -163 +188 @@
 }
 
+=item B<pb_filter_file_inplace>
+
+This function applies all filters to a file in place.
+
+It takes 8 parameters.
+
+The first parameter is the pointer on the hash of filters.
+The second parameter is the destination file after filtering.
+The third parameter is the package name.
+The fourth parameter is the version of the package.
+The fifth parameter is the tag of the package.
+The sixth parameter is the revision of the package.
+The seventh parameter is the current date.
+The eighth parameter is the packager name.
+
+=cut
+
 # Function which applies filter on files (external call)
 sub pb_filter_file_inplace {
@@ -169 +211 @@
 my %filter=%$ptr;
 my $destfile=shift;
-my $pbproj=shift;
 my $pbpkg=shift;
 my $pbver=shift;
@@ -180 +221 @@
 copy($destfile,$cp) || die "Unable to create $cp";
 
-pb_filter_file($cp,$ptr,$destfile,$pbproj,$pbpkg,$pbver,$pbtag,$pbrev,$pbdate,$pbpackager);
+pb_filter_file($cp,$ptr,$destfile,$pbpkg,$pbver,$pbtag,$pbrev,$pbdate,$pbpackager);
 unlink $cp;
 }
+
+=item B<pb_filter_file>
+
+This function applies all filters on a file to generate a new filtered one.
+
+It takes 9 parameters.
+
+The first parameter is the original file to filter.
+The second parameter is the pointer on the hash of filters.
+The third parameter is the destination file after filtering.
+The fourth parameter is the package name.
+The fifth parameter is the version of the package.
+The sixth parameter is the tag of the package.
+The seventh parameter is the revision of the package.
+The eighth parameter is the current date.
+The nineth parameter is the packager name.
+
+=cut
+
 
 # Function which applies filter on files (external call)
@@ -191 +251 @@
 my %filter=%$ptr;
 my $destfile=shift;
-my $pbproj=shift;
 my $pbpkg=shift;
 my $pbver=shift;
@@ -222 +281 @@
 }
 
+=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
+
 1;