Skip to content

Commit

Permalink
Add documentation for new methods created. Mention in ChangeLog.
Browse files Browse the repository at this point in the history
Methods: get_pkgname, get_pkgver, get_pkgrel, set_pkgrel.
Also added 'pkgrel' as a template variable for get_pkgvars().
  • Loading branch information
juster committed Feb 18, 2010
1 parent 49a7a3e commit e5c699a
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
8 changes: 8 additions & 0 deletions ChangeLog
@@ -1,3 +1,11 @@
2010-02-18 Justin Davis <juster@cpan.org>

* lib/CPANPLUS/Dist/Arch.pm (get_pkgname): Added method.
(get_pkgver): Added method.
(get_pkgrel): Added method.
(set_pkgrel): Added method.
(get_pkgvars): Added 'pkgrel' as a new template variable.

2010-02-17 Justin Davis <juster@cpan.org>

* script/cpan2aur (confirm_overwrite): Fixed bug where the
Expand Down
22 changes: 22 additions & 0 deletions lib/CPANPLUS/Dist/Arch.pod
Expand Up @@ -221,6 +221,28 @@ When using the CPANPLUS module in a perl script to create packages,
these public methods are available. See the cpanpkgbuild.pl script
included in the examples directory for an example.

=head3 get_pkgname

Usage : say $dist->get_pkgname;
Returns : The name of the package.

=head3 get_pkgver

Usage : say $dist->get_pkgver;
Returns : The version of the package.

=head3 get_pkgrel

Usage : say "Release: ", $dist->get_pkgrel;
Notes : Default is 1, unless set_pkgrel is used.
Returns : The package release number.

=head3 set_pkgrel

Usage : $newrel = $dist->set_pkgrel( 2 );
Params : $new_relnum - Croaks if this is not a number.
Returns : The new release number.

=head3 set_destdir

Usage : $dist->set_destdir('~/pkg/perl');
Expand Down

0 comments on commit e5c699a

Please sign in to comment.