J. J. Merelo-Guervós
and 1 contributors

NAME

Git::Repo::Commits - Get all commits in a repository

VERSION

This document describes Git::Repo::Commits version 0.0.3

SYNOPSIS

    use Git::Repo::Commits;

    my $commits = new Git::Repo::Commits /home/is/where/the/repo/is

  

DESCRIPTION

new $repository

Creates an object with information about all commits

commits

Returns an array with commit information, an array item per commit, in the shape

    { author => $author,
      committer => $committer,
      files => \@files }

hashes

Returns an array with the hashes of all commits in the repo.

name

Returns the name of the directory, which usually is also the name of the repo.

CONFIGURATION AND ENVIRONMENT

Git::Repo::Commits requires no configuration files or environment variables. It might be the case that git is not installed and this fails, but probably not.

DEPENDENCIES

Depends on Git, which should be available either from your git installation or from CPAN.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to bug-git-repo-commits@rt.cpan.org, or through the web interface at http://rt.cpan.org, or, even better, at the https://github.com/JJ/perl-git-commit/issues in GitHub.

AUTHOR

JJ <JMERELO@cpan.org>

LICENCE AND COPYRIGHT

Copyright (c) 2017, JJ <JMERELO@cpan.org>. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.