NAME

Git::Repository::Plugin::Blame - Add a blame() method to Git::Repository.

VERSION

Version 1.4.0

SYNOPSIS

        # Load the plugin.
        use Git::Repository 'Blame';

        my $repository = Git::Repository->new();

        # Get the git blame information.
        my $blame_lines = $repository->blame( $file );

DESCRIPTION

This module adds a new blame() method to Git::Repository, which can be used to determine what the last change for each line in a file is.

METHODS

blame()

Return the git blame information for a given file as an arrayref of Git::Repository::Plugin::Blame::Line objects.

        my $blame_lines = $repository->blame(
                $file,
                use_cache => $boolean, # default 0
        );

Arguments:

• use_cache (default: 0)

  Cache the git blame output.

• ignore_whitespace (default: 0)

  Ignore whitespace when comparing the parent's version and the child's to find where the lines came from.

BUGS

Please report any bugs or feature requests through the web interface at https://github.com/guillaumeaubert/Git-Repository-Plugin-Blame/issues. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

        perldoc Git::Repository::Plugin::Blame

You can also look for information at:

• GitHub (report bugs there)

  https://github.com/guillaumeaubert/Git-Repository-Plugin-Blame/issues

• AnnoCPAN: Annotated CPAN documentation

  http://annocpan.org/dist/Git-Repository-Plugin-Blame

• CPAN Ratings

  http://cpanratings.perl.org/d/Git-Repository-Plugin-Blame

• MetaCPAN

  https://metacpan.org/release/Git-Repository-Plugin-Blame

AUTHOR

Guillaume Aubert, <aubertg at cpan.org>.

COPYRIGHT & LICENSE

Copyright 2012-2017 Guillaume Aubert.

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

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the LICENSE file for more details.