.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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::Repository::Log 3pm"
.TH Git::Repository::Log 3pm "2022-06-14" "perl v5.34.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::Repository::Log \- Class representing git log data
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    # load the Log plugin
\&    use Git::Repository \*(AqLog\*(Aq;
\&
\&    # get the log for last commit
\&    my ($log) = Git::Repository\->log( \*(Aq\-1\*(Aq );
\&
\&    # get the author\*(Aqs email
\&    print my $email = $log\->author_email;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`Git::Repository::Log\*(C'\fR is a class whose instances represent
log items from a \fBgit log\fR stream.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
This method shouldn't be used directly. Git::Repository::Log::Iterator
should be the preferred way to create \f(CW\*(C`Git::Repository::Log\*(C'\fR objects.
.SS "new"
.IX Subsection "new"
Create a new \f(CW\*(C`Git::Repository::Log\*(C'\fR instance, using the list of key/values
passed as parameters. The supported keys are (from the output of
\&\f(CW\*(C`git log \-\-pretty=raw\*(C'\fR):
.IP "commit" 4
.IX Item "commit"
The commit id (ignoring the extra information added by \fI\-\-decorate\fR).
.IP "tree" 4
.IX Item "tree"
The tree id.
.IP "parent" 4
.IX Item "parent"
The parent list, separated by spaces.
.IP "author" 4
.IX Item "author"
The author information.
.IP "committer" 4
.IX Item "committer"
The committer information.
.IP "message" 4
.IX Item "message"
The log message (including the 4\-space indent normally output by \fBgit log\fR).
.IP "gpgsig" 4
.IX Item "gpgsig"
The commit signature.
.IP "mergetag" 4
.IX Item "mergetag"
The mergetag information.
.IP "diff_from" 4
.IX Item "diff_from"
The commit from which the diff was taken.
.Sp
This is the extra \f(CW\*(C`from\*(C'\fR information on the commit header that is
added by \fBgit\fR when the log contains a diff (using the \f(CW\*(C`\-p\*(C'\fR or
\&\f(CW\*(C`\-\-name\-status\*(C'\fR option). In this case, \f(CW\*(C`git log\*(C'\fR may show the same
commit several times.
.IP "extra" 4
.IX Item "extra"
Any extra text that might be added by extra options passed to \fBgit log\fR
(e.g. \f(CW\*(C`\-p\*(C'\fR or \f(CW\*(C`\-\-name\-status\*(C'\fR).
.PP
Note that since \f(CW\*(C`git tag \-\-pretty=raw\*(C'\fR does not provide the \f(CW\*(C`encoding\*(C'\fR
header (and provides the message properly decoded), this information
will not be available via Git::Repository::Plugin::Log.
.SH "ACCESSORS"
.IX Header "ACCESSORS"
The following accessors methods are recognized. They all return scalars,
except for \f(CW\*(C`parent()\*(C'\fR, which returns a list.
.SS "Commit information"
.IX Subsection "Commit information"
.IP "commit" 4
.IX Item "commit"
.PD 0
.IP "tree" 4
.IX Item "tree"
.IP "parent" 4
.IX Item "parent"
.PD
.SS "Author and committer information"
.IX Subsection "Author and committer information"
.IP "author" 4
.IX Item "author"
.PD 0
.IP "committer" 4
.IX Item "committer"
.PD
The original author/committer line
.IP "author_name" 4
.IX Item "author_name"
.PD 0
.IP "committer_name" 4
.IX Item "committer_name"
.IP "author_email" 4
.IX Item "author_email"
.IP "committer_email" 4
.IX Item "committer_email"
.PD
.SS "Date information"
.IX Subsection "Date information"
.IP "author_gmtime" 4
.IX Item "author_gmtime"
.PD 0
.IP "committer_gmtime" 4
.IX Item "committer_gmtime"
.IP "author_localtime" 4
.IX Item "author_localtime"
.IP "committer_localtime" 4
.IX Item "committer_localtime"
.IP "author_tz" 4
.IX Item "author_tz"
.IP "committer_tz" 4
.IX Item "committer_tz"
.PD
.SS "Log information"
.IX Subsection "Log information"
.IP "raw_message" 4
.IX Item "raw_message"
The log message with the 4\-space indent output by \fBgit log\fR.
.IP "message" 4
.IX Item "message"
The unindented version of the log message.
.IP "subject" 4
.IX Item "subject"
.PD 0
.IP "body" 4
.IX Item "body"
.PD
.SS "Signature-related information"
.IX Subsection "Signature-related information"
.IP "gpgsig" 4
.IX Item "gpgsig"
.PD 0
.IP "mergetag" 4
.IX Item "mergetag"
.PD
.SS "Extra information"
.IX Subsection "Extra information"
.IP "extra" 4
.IX Item "extra"
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2010\-2016 Philippe Bruhat (BooK), all rights reserved.
.SH "LICENSE"
.IX Header "LICENSE"
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.