.\" -*- 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::Worktree 3pm"
.TH Git::Raw::Worktree 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::Worktree \- Git worktree class
.SH VERSION
.IX Header "VERSION"
version 0.90
.SH DESCRIPTION
.IX Header "DESCRIPTION"
A Git::Raw::Worktree represents a git worktree.
.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 "add( $repo, $name, $path )"
.el .SS "add( \f(CW$repo\fP, \f(CW$name\fP, \f(CW$path\fP )"
.IX Subsection "add( $repo, $name, $path )"
Add a new worktree.
.ie n .SS "lookup( $repo, $name )"
.el .SS "lookup( \f(CW$repo\fP, \f(CW$name\fP )"
.IX Subsection "lookup( $repo, $name )"
Lookup a worktree.
.SS "name( )"
.IX Subsection "name( )"
Retrieve the name of the worktree.
.SS "path( )"
.IX Subsection "path( )"
Retrieve the filesystem path for the worktree.
.SS "repository( )"
.IX Subsection "repository( )"
Open the worktree as a repository. Returns a Git::Raw::Repository object.
.ie n .SS "list( $repo )"
.el .SS "list( \f(CW$repo\fP )"
.IX Subsection "list( $repo )"
List all worktress for \f(CW$repo\fR.
.SS "is_locked( )"
.IX Subsection "is_locked( )"
Check if the worktree is locked. Returns the reason for locking or a falsy value.
.SS "is_prunable( \e%prune_opts )"
.IX Subsection "is_prunable( %prune_opts )"
Check if the worktree can be pruned. Valid fields for th \f(CW%prune_opts\fR hash
are:
.IP \(bu 4
"flags"
.Sp
Prune flags. Valid values include:
.RS 4
.IP \(bu 8
"valid"
.Sp
Prune the working tree even if working tree is valid.
.IP \(bu 8
"locked"
.Sp
Prune the working tree even if it is locked.
.IP \(bu 8
"working_tree"
.Sp
Prune checked out working tree.
.RE
.RS 4
.RE
.ie n .SS "lock( $reason )"
.el .SS "lock( \f(CW$reason\fP )"
.IX Subsection "lock( $reason )"
Lock the worktree with \f(CW$reason\fR.
.SS "unlock( )"
.IX Subsection "unlock( )"
Unlock the worktree.
.SS "validate( )"
.IX Subsection "validate( )"
Check if the worktree is valid. A valid worktree requirest both the git data
structures inside the linked parent repository and the linked working copy to
be present.
.SS "prune( \e%prune_opts )"
.IX Subsection "prune( %prune_opts )"
Prune the working tree. Pruning the working tree removes the git data structures
on disk. See \f(CW\*(C`is_prunable\*(C'\fR for valid values of \f(CW%prune_opts\fR.
.SH AUTHOR
.IX Header "AUTHOR"
Jacques Germishuys <jacquesg@cpan.org>
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright 2018 Jacques Germishuys.
.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.