Changeset 409 in ProjectBuilder for devel/pb/lib/ProjectBuilder/Changelog.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/Changelog.pm (modified) (2 diffs)

devel/pb/lib/ProjectBuilder/Changelog.pm

@@ -38 +38 @@
 =head1 DESCRIPTION
 
-blabla
+This modules provides generic functions suitable for changelog management for project-builder.org
+
+=head1 USAGE
+
+=over 4
+
+=item B<pb_changelog>
+
+Function that generates the changelog used in build files, or for announcements (web, mailing-list, ...)
+
+It takes up to 9 parameters:
+The first parameter is the type of the distribution.
+The second parameter is the package name generated.
+The third parameter is the version of the package.
+The fourth parameter is the tag of the package.
+The fifth parameter is the suffix of the package.
+The sixth parameter is now unused.
+The seventh parameter is the file descriptor on which to write the changelog content.
+The eighth parameter is a flag in the configuration file indicating whether we want changelog expansion or not.
+The nineth parameter is the potential changelog file pbcl.
 
 =cut
@@ -179 +198 @@
 }
 
+
+=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;