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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
package Git::Raw::Tree;
$Git::Raw::Tree::VERSION = '0.87';
use strict;
use warnings;
use overload
'""' => sub { return $_[0] -> id },
fallback => 1;
use Git::Raw;
=head1 NAME
Git::Raw::Tree - Git tree class
=head1 VERSION
version 0.87
=head1 DESCRIPTION
A L<Git::Raw::Tree> represents a Git tree.
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 lookup( $repo, $id )
Retrieve the tree corresponding to C<$id>. This function is pretty much the same
as C<$repo-E<gt>lookup($id)> except that it only returns trees. If the tree
doesn't exist, this function will return C<undef>.
=head2 owner( )
Retrieve the L<Git::Raw::Repository> owning the tree.
=head2 id( )
Retrieve the id of the tree, as a string.
=head2 entries( )
Retrieve a list of L<Git::Raw::Tree::Entry> objects.
=head2 entry_byname( $name )
Retrieve a L<Git::Raw::Tree::Entry> object by name. If the entry cannot be found,
this function will return C<undef>.
=head2 entry_bypath( $path )
Retrieve a L<Git::Raw::Tree::Entry> object by path. If the entry cannot be found,
this function will return C<undef>.
=head2 merge( $ancestor, $theirs, [\%merge_opts] )
Merge C<$theirs> into this tree. C<$ancestor> and C<$theirs> should be
L<Git::Raw::Tree> objects. See C<Git::Raw::Repository-E<gt>merge()> for valid
C<%merge_opts> values. Returns a L<Git::Raw::Index> object containing the
merge result.
=head2 diff( [\%diff_opts] )
Compute the L<Git::Raw::Diff> between two trees. See
C<Git::Raw::Repository-E<gt>diff()> for valid C<%diff_opts> values.
=head2 is_tree( )
Returns true.
=head2 is_blob( )
Returns false.
=head1 AUTHOR
Alessandro Ghedini <alexbio@cpan.org>
Jacques Germishuys <jacquesg@striata.com>
=head1 LICENSE AND COPYRIGHT
Copyright 2012 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::Tree
|
