1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
|
package Git::Raw::Index::Entry;
$Git::Raw::Index::Entry::VERSION = '0.87';
use strict;
use warnings;
use Git::Raw;
=head1 NAME
Git::Raw::Index::Entry - Git index entry class
=head1 VERSION
version 0.87
=head1 DESCRIPTION
A L<Git::Raw::Index::Entry> represents an index entry in a Git repository index.
B<WARNING>: The API of this module is unstable and may change without warning
(any change will be appropriately documented in the changelog).
=head1 METHODS
=head2 id( )
Retrieve the id of the index entry as a string.
=head2 is_conflict( )
Check if the entry has a non-zero stage entry.
=head2 mode( )
Retrieve the mode of the index entry. Note that this is returned as a
number, not a string.
=head2 path( )
Retrieve the path of the index entry.
=head2 size( )
Retrieve the size of the index entry.
=head2 stage( )
Retrieve the stage number for the index entry.
=head2 blob( )
Retrieve the blob for the the index entry. Returns a L<Git::Raw::Blob> object.
=head2 clone( $path )
Clone the entry, but use C<$path> as the entry's path. B<WARNING>: Use with
caution. This is only useful for scenarios where a conflict entry should be
added to the index where C<$path> should be used.
=head1 AUTHOR
Alessandro Ghedini <alexbio@cpan.org>
Jacques Germishuys <jacquesg@striata.com>
=head1 LICENSE AND COPYRIGHT
Copyright 2014 Alessandro Ghedini.
This program is free software; you can redistribute it and/or modify it
under the terms of either: the GNU General Public License as published
by the Free Software Foundation; or the Artistic License.
See http://dev.perl.org/licenses/ for more information.
=cut
1; # End of Git::Raw::Index::Entry
|