.\" -*- 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::Branch 3pm"
.TH Git::Raw::Branch 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::Branch \- Git branch class
.SH VERSION
.IX Header "VERSION"
version 0.90
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    use Git::Raw;
\&
\&    # open the Git repository at $path
\&    my $repo = Git::Raw::Repository \-> open($path);
\&
\&    # create a new branch named \*(Aqsome_branch\*(Aq
\&    $repo \-> branch(\*(Aqsome_branch\*(Aq, $repo \-> head \-> target);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Helper class for branch manipulation. Note that a Git branch is nothing more
than a Git::Raw::Reference, so this class inherits all methods from it.
.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 "create( $repo, $name, $target )"
.el .SS "create( \f(CW$repo\fP, \f(CW$name\fP, \f(CW$target\fP )"
.IX Subsection "create( $repo, $name, $target )"
Create a new branch given a name and a target object (either a
Git::Raw::Commit or a Git::Raw::Tag).
.ie n .SS "lookup( $repo, $name, $is_local )"
.el .SS "lookup( \f(CW$repo\fP, \f(CW$name\fP, \f(CW$is_local\fP )"
.IX Subsection "lookup( $repo, $name, $is_local )"
Retrieve the branch corresponding to the given branch name.
.ie n .SS "move( $name, $force )"
.el .SS "move( \f(CW$name\fP, \f(CW$force\fP )"
.IX Subsection "move( $name, $force )"
Rename the branch to \f(CW$name\fR. Note that in order to get the updated branch
object, an additional \f(CW\*(C`Git::Raw::Branch\->lookup()\*(C'\fR is needed.
.SS "upstream( [$upstream] )"
.IX Subsection "upstream( [$upstream] )"
Retrieve or set the reference supporting the remote tracking branch, given the
local branch. If there is no corresponding supporting reference, this function
will return \f(CW\*(C`undef\*(C'\fR. \f(CW$upstream\fR may either be a Git::Raw::Reference, a
string containing the upstream reference name or \f(CW\*(C`undef\*(C'\fR. If \f(CW$upstream\fR is
set to \f(CW\*(C`undef\*(C'\fR, the remote tracking branch association is removed.
.SS "upstream_name( )"
.IX Subsection "upstream_name( )"
Return the name of the reference supporting the remote tracking branch, given
the the local branch. If there is no associated remote tracking branch, this
function will return \f(CW\*(C`undef\*(C'\fR.
.SS "remote_name( )"
.IX Subsection "remote_name( )"
Return the name of remote that the remote tracking branch belongs to, given
the local branch. If there is no associated remote tracking branch, this
function will return \f(CW\*(C`undef\*(C'\fR.
.SS "is_head( )"
.IX Subsection "is_head( )"
Check if the current local branch is pointed at by HEAD.
.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.