.\" Automatically generated by Pod::Man 4.14 (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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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::Rebase 3pm"
.TH Git::Raw::Rebase 3pm "2022-10-29" "perl v5.36.0" "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::Rebase \- Git rebase class
.SH "VERSION"
.IX Header "VERSION"
version 0.90
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A Git::Raw::Rebase represents a git rebase.
.PP
\&\fB\s-1WARNING\s0\fR: The \s-1API\s0 of this module is unstable and may change without warning
(any change will be appropriately documented in the changelog).
.SH "METHODS"
.IX Header "METHODS"
.SS "abort( )"
.IX Subsection "abort( )"
Abort the current rebase, resetting the repository and working directory to
their state before rebase began.
.ie n .SS "commit( $author, $committer )"
.el .SS "commit( \f(CW$author\fP, \f(CW$committer\fP )"
.IX Subsection "commit( $author, $committer )"
Commit the current patch. All conflicts that may have been introduced by the
last call to \f(CW\*(C`next\*(C'\fR must have been resolved. Returns a Git::Raw::Commit
object. Both \f(CW$author\fR and \f(CW$committer\fR should be Git::Raw::Signature
objects.
.SS "current_operation( )"
.IX Subsection "current_operation( )"
Get the current operation. Returns a Git::Raw::Rebase::Operation object or
\&\f(CW\*(C`undef\*(C'\fR is there is no operation.
.ie n .SS "finish( $signature )"
.el .SS "finish( \f(CW$signature\fP )"
.IX Subsection "finish( $signature )"
Finish the current rebase.
.SS "inmemory_index( )"
.IX Subsection "inmemory_index( )"
Get the index produced by the last operation which will be committed by the
next call to \f(CW\*(C`commit\*(C'\fR. This is useful for resolving conflicts before committing
them. Returns a Git::Raw::Index object.
.ie n .SS "new( $repo, $branch, $upstream, $onto, [\e%rebase_opts])"
.el .SS "new( \f(CW$repo\fP, \f(CW$branch\fP, \f(CW$upstream\fP, \f(CW$onto\fP, [\e%rebase_opts])"
.IX Subsection "new( $repo, $branch, $upstream, $onto, [%rebase_opts])"
Initialise a new rebase operation, to rebase the changs in \f(CW$branch\fR relative
to \f(CW$upstream\fR onto \f(CW$onto\fR. \f(CW$branch\fR, \f(CW$upstream\fR and \f(CW$onto\fR must be
Git::Raw::AnnotatedCommit objects. Valid fields for the \f(CW%rebase_opts\fR hash
include:
.IP "\(bu" 4
\&\*(L"quiet\*(R"
.Sp
Instruct other clients working on this rebase that a quiet rebase experienced
is required. This is provided for interoperability with other Git tools.
.IP "\(bu" 4
\&\*(L"inmemory\*(R"
.Sp
Perform an in-memory rebase. This allows for stepping through each operation
and committing the rebased changes without rewinding \s-1HEAD\s0 or putting the
repository in a rebase state. This will not interfere with the working directory.
.IP "\(bu" 4
\&\*(L"rewrite_notes_ref\*(R"
.Sp
Name of the notes reference used to rewrite notes for rebased commits when
finishing the rebase. If not provided, the contents of the configuration option
\&\f(CW\*(C`notes.rewriteRef\*(C'\fR is examined unless the configuration option \f(CW\*(C`notes.rewrite.rebase\*(C'\fR
is set to a false value. If \f(CW\*(C`notes.rewriteRef\*(C'\fR is also not set, no notes
will be rewritten.
.IP "\(bu" 4
\&\*(L"merge_opts\*(R"
.Sp
See \f(CW\*(C`Git::Raw::Repository\->merge()\*(C'\fR for valid \f(CW%merge_opts\fR values.
.IP "\(bu" 4
\&\*(L"checkout_opts\*(R"
.Sp
See \f(CW\*(C`Git::Raw::Repository\->checkout()\*(C'\fR for valid \f(CW%checkout_opts\fR values.
.SS "next( )"
.IX Subsection "next( )"
Perform the next rebase operation. If the operation is one that applies a patch
then the patch will be applied and the index and working directory will be
updated with the changes. If there are conflicts, these need to be resolved
before calling \f(CW\*(C`commit\*(C'\fR. Returns a Git::Raw::Rebase::Operation object, or
\&\f(CW\*(C`undef\*(C'\fR if there aren't any rebase operations left.
.SS "open( )"
.IX Subsection "open( )"
Open an existing rebase.
.SS "operation_count( )"
.IX Subsection "operation_count( )"
Get the number of operations that are to be applied.
.SS "operations( )"
.IX Subsection "operations( )"
Get all operations that are to be applied. Returns a list of
Git::Raw::Rebase::Operation objects.
.SS "orig_head_name( )"
.IX Subsection "orig_head_name( )"
Get the original \s-1HEAD\s0 ref name.
.SS "orig_head_id( )"
.IX Subsection "orig_head_id( )"
Get the original \s-1HEAD\s0 id.
.SS "onto_name( )"
.IX Subsection "onto_name( )"
Get the onto ref name.
.SS "onto_id( )"
.IX Subsection "onto_id( )"
Get the onto id.
.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 \s-1GNU\s0 General Public License as published
by the Free Software Foundation; or the Artistic License.
.PP
See http://dev.perl.org/licenses/ for more information.