.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Git::Raw::Reflog 3pm"
.TH Git::Raw::Reflog 3pm "2018-05-15" "perl v5.26.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::Reflog \- Git reflog class
.SH "VERSION"
.IX Header "VERSION"
version 0.79
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Git::Raw;
\&
\&    # open the Git repository at $path
\&    my $repo = Git::Raw::Repository \-> open($path);
\&
\&    # get the master branch
\&    my $master = Git::Raw::Branch \-> lookup($repo, \*(Aqmaster\*(Aq, 1);
\&
\&    # retrieve the reflog for \*(Aqmaster\*(Aq
\&    my $reflog = $master \-> reflog;
\&
\&    # print out reflog information
\&    my @entries = $reflog \-> entries;
\&    foreach my $entry (@entries) {
\&        my $committer = $entry \-> committer;
\&        print "Committer:", "\en";
\&        print "\et", "Name:   ", $committer \-> name, "\en";
\&        print "\et", "E\-Mail  ", $committer \-> email, "\en";
\&        print "\et", "Time:   ", $committer \-> time, "\en";
\&        print "\et", "Offset: ", $committer \-> offset, "\en";
\&        print "\en";
\&
\&        print "Message: ", $entry \-> message, "\en";
\&        print "Old id:  ", $entry \-> old_id, "\en";
\&        print "New id:  ", $entry \-> new_id, "\en";
\&    }
\&
\&    # add a new entry to the reflog
\&    my $signature = Git::Raw::Signature \-> default($repo);
\&    $reflog \-> append("Hello", $signature);
\&    $reflog \-> write;
\&
\&    # drop an entry from the reflog
\&    $reflog \-> drop(0);
\&    $reflog \-> write;
\&
\&    # remove the reflog
\&    $reflog \-> delete;
\&    $reflog \-> write;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A \f(CW\*(C`Git::Raw::Reflog\*(C'\fR represents a Git reflog.
.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"
.ie n .SS "open( $reference )"
.el .SS "open( \f(CW$reference\fP )"
.IX Subsection "open( $reference )"
Open the reflog for the reference \f(CW$reference\fR.
.SS "delete( )"
.IX Subsection "delete( )"
Delete the reflog for the reference.
.ie n .SS "append( $message [, $signature])"
.el .SS "append( \f(CW$message\fP [, \f(CW$signature\fP])"
.IX Subsection "append( $message [, $signature])"
Add a new entry to the reflog. If \f(CW$signature\fR is not provided,
the default signature, \f(CW\*(C`Git::Raw::Signature\->default()\*(C'\fR will be used.
.ie n .SS "drop( $index )"
.el .SS "drop( \f(CW$index\fP )"
.IX Subsection "drop( $index )"
Remove entry \f(CW$index\fR from the reflog.
.SS "write( )"
.IX Subsection "write( )"
Write the reflog back to disk.
.SS "entry_count( )"
.IX Subsection "entry_count( )"
Retrieve the number of entries in the reflog.
.ie n .SS "entries( [$index, $count] )"
.el .SS "entries( [$index, \f(CW$count\fP] )"
.IX Subsection "entries( [$index, $count] )"
Retrieve a list of Git::Raw::Reflog::Entry objects.
.SH "AUTHOR"
.IX Header "AUTHOR"
Alessandro Ghedini <alexbio@cpan.org>
.PP
Jacques Germishuys <jacquesg@striata.com>
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright 2014 Alessandro Ghedini.
.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.