.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Git::Raw::Tree 3pm"
.TH Git::Raw::Tree 3pm 2024-03-07 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Git::Raw::Tree \- Git tree class
.SH VERSION
.IX Header "VERSION"
version 0.90
.SH DESCRIPTION
.IX Header "DESCRIPTION"
A Git::Raw::Tree represents a Git tree.
.PP
\&\fBWARNING\fR: The API of this module is unstable and may change without warning
(any change will be appropriately documented in the changelog).
.SH METHODS
.IX Header "METHODS"
.ie n .SS "lookup( $repo, $id )"
.el .SS "lookup( \f(CW$repo\fP, \f(CW$id\fP )"
.IX Subsection "lookup( $repo, $id )"
Retrieve the tree corresponding to \f(CW$id\fR. This function is pretty much the same
as \f(CW\*(C`$repo\->lookup($id)\*(C'\fR except that it only returns trees. If the tree
doesn't exist, this function will return \f(CW\*(C`undef\*(C'\fR.
.SS "owner( )"
.IX Subsection "owner( )"
Retrieve the Git::Raw::Repository owning the tree.
.SS "id( )"
.IX Subsection "id( )"
Retrieve the id of the tree, as a string.
.SS "entries( )"
.IX Subsection "entries( )"
Retrieve a list of Git::Raw::Tree::Entry objects.
.ie n .SS "entry_byname( $name )"
.el .SS "entry_byname( \f(CW$name\fP )"
.IX Subsection "entry_byname( $name )"
Retrieve a Git::Raw::Tree::Entry object by name. If the entry cannot be found,
this function will return \f(CW\*(C`undef\*(C'\fR.
.ie n .SS "entry_bypath( $path )"
.el .SS "entry_bypath( \f(CW$path\fP )"
.IX Subsection "entry_bypath( $path )"
Retrieve a Git::Raw::Tree::Entry object by path. If the entry cannot be found,
this function will return \f(CW\*(C`undef\*(C'\fR.
.ie n .SS "merge( $ancestor, $theirs, [\e%merge_opts] )"
.el .SS "merge( \f(CW$ancestor\fP, \f(CW$theirs\fP, [\e%merge_opts] )"
.IX Subsection "merge( $ancestor, $theirs, [%merge_opts] )"
Merge \f(CW$theirs\fR into this tree. \f(CW$ancestor\fR and \f(CW$theirs\fR should be
Git::Raw::Tree objects.  See \f(CW\*(C`Git::Raw::Repository\->merge()\*(C'\fR for valid
\&\f(CW%merge_opts\fR values. Returns a Git::Raw::Index object containing the
merge result.
.SS "diff( [\e%diff_opts] )"
.IX Subsection "diff( [%diff_opts] )"
Compute the Git::Raw::Diff between two trees. See
\&\f(CW\*(C`Git::Raw::Repository\->diff()\*(C'\fR for valid \f(CW%diff_opts\fR values.
.SS "is_tree( )"
.IX Subsection "is_tree( )"
Returns true.
.SS "is_blob( )"
.IX Subsection "is_blob( )"
Returns false.
.SH AUTHOR
.IX Header "AUTHOR"
Alessandro Ghedini <alexbio@cpan.org>
.PP
Jacques Germishuys <jacquesg@cpan.org>
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright 2012 Alessandro Ghedini.
.PP
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.
.PP
See http://dev.perl.org/licenses/ for more information.