.\" -*- 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::Rebase::Operation 3pm" .TH Git::Raw::Rebase::Operation 3pm 2024-01-10 "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::Rebase::Operation \- Git rebase operation class .SH VERSION .IX Header "VERSION" version 0.90 .SH DESCRIPTION .IX Header "DESCRIPTION" A Git::Raw::Rebase::Operation represents a git rebase operation. .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" .SS "type( )" .IX Subsection "type( )" The type of rebase operation. .SS "id( )" .IX Subsection "id( )" The commit ID being cherry-picked. This will return \f(CW\*(C`undef\*(C'\fR for \f(CW\*(C`EXEC\*(C'\fR operations. .SS "exec( )" .IX Subsection "exec( )" The executable the user has requested to run. This will return \f(CW\*(C`undef\*(C'\fR for all but \f(CW\*(C`EXEC\*(C'\fR operations. .SH CONSTANTS .IX Header "CONSTANTS" .SS PICK .IX Subsection "PICK" The given commit is to be cherry-picked. The client should commit the changes and continue if there are no conflicts. .SS REWORD .IX Subsection "REWORD" The given commit is to be cherry-picked, but the client should prompt the user to provide an updated commit message. .SS EDIT .IX Subsection "EDIT" The given commit is to be cherry-picked, but the client should stop to allow the user to edit the changes before committing them. .SS SQUASH .IX Subsection "SQUASH" The given commit is to be squashed into the previous commit. The commit message will be merged with the previous message. .SS FIXUP .IX Subsection "FIXUP" The given commit is to be squashed into the previous commit. The commit message from this commit will be discarded. .SS EXEC .IX Subsection "EXEC" No commit will be cherry-picked. The client should run the given command and (if successful) continue. .SH AUTHOR .IX Header "AUTHOR" Jacques Germishuys .SH "LICENSE AND COPYRIGHT" .IX Header "LICENSE AND COPYRIGHT" Copyright 2016 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.