.\" -*- 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::Builder 3pm"
.TH Git::Raw::Tree::Builder 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::Builder \- Git tree builder class
.SH VERSION
.IX Header "VERSION"
version 0.90
.SH DESCRIPTION
.IX Header "DESCRIPTION"
A Git::Raw::Tree::Builder allows you to build Git tree objects.
.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 "new( $repo, [$tree] )"
.el .SS "new( \f(CW$repo\fP, [$tree] )"
.IX Subsection "new( $repo, [$tree] )"
Creates a new tree builder that will build trees in \f(CW$repo\fR.  If \f(CW$tree\fR is
passed, the contents of the tree builder are initialized from the contents of
\&\f(CW$tree\fR.
.SS "clear( )"
.IX Subsection "clear( )"
Clears the tree builder of all entries.
.SS "entry_count( )"
.IX Subsection "entry_count( )"
Returns the number of entries contained in this tree builder.
.ie n .SS "get( $filename )"
.el .SS "get( \f(CW$filename\fP )"
.IX Subsection "get( $filename )"
Return a Git::Raw::TreeEntry corresponding to \f(CW$filename\fR.
Returns \f(CW\*(C`undef\*(C'\fR if no such entry exists.
.ie n .SS "insert( $filename, $object, $mode )"
.el .SS "insert( \f(CW$filename\fP, \f(CW$object\fP, \f(CW$mode\fP )"
.IX Subsection "insert( $filename, $object, $mode )"
Adds (or updates) an entry in this tree builder.  \f(CW$object\fR
can be either a Git::Raw::Tree or Git::Raw::Blob object.
Returns a Git::Raw::Tree::Entry object on success.
.ie n .SS "remove( $filename )"
.el .SS "remove( \f(CW$filename\fP )"
.IX Subsection "remove( $filename )"
Removes the entry associated with the filename \f(CW$filename\fR from this tree
builder.
.SS "write( )"
.IX Subsection "write( )"
Writes the tree object we've been building into the repository.
Returns a Git::Raw::Tree object on success.
.SH AUTHOR
.IX Header "AUTHOR"
Rob Hoelz <rob@hoelz.ro>
.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.