.\" 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 "Arch::Log 3pm"
.TH Arch::Log 3pm "2022-06-08" "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"
Arch::Log \- class representing Arch patch\-log
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 5
\&    use Arch::Log;
\&    my $log = Arch::Log\->new($rfc2822_message_string);
\&    printf "Patch log date: %s\en", $log\->header(\*(Aqstandard_date\*(Aq);
\&    print $log\->dump;
\&    my $first_new_file = $log\->get_headers\->{new_files}\->[0];
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class represents the patch-log concept in Arch and provides some
useful methods.
.SH "METHODS"
.IX Header "METHODS"
The following class methods are available:
.PP
\&\fBget_message\fR,
\&\fBget_headers\fR,
\&\fBheader\fR,
\&\fBget_changes\fR,
\&\fBsplit_version\fR,
\&\fBget_version\fR,
\&\fBget_revision\fR,
\&\fBget_revision_kind\fR,
\&\fBget_revision_desc\fR,
\&\fBdump\fR.
.IP "\fBget_message\fR" 4
.IX Item "get_message"
Return the original message with that the object was constructed.
.IP "\fBget_headers\fR" 4
.IX Item "get_headers"
Return the hashref of all headers including body, see also \f(CW\*(C`header\*(C'\fR method.
.IP "\fBheader\fR name" 4
.IX Item "header name"
.PD 0
.IP "\fBheader\fR name [new_value]" 4
.IX Item "header name [new_value]"
.PD
Get or set the named header. The special name 'body' represents the
message body (the text following the headers).
.IP "\fBbody\fR [new_value]" 4
.IX Item "body [new_value]"
.PD 0
.IP "existing_header_name [new_value]" 4
.IX Item "existing_header_name [new_value]"
.PD
This is just a shortcut for \f(CW\*(C`header\*(C'\fR('\fImethod\fR'). However unlike
\&\f(CW\*(C`header\*(C'\fR('\fImethod\fR'), \fImethod\fR fails instead of returning undef if the log
does not have the given header name.
.IP "\fBget_changes\fR" 4
.IX Item "get_changes"
Return a list of changes in the corresponding changeset.
.Sp
\&\fB\s-1ATTENTION\s0!\fR Patch logs do not distinguish metadata (ie permission)
changes from ordinary content changes. Permission changes will be
represented with a change type of 'M'. This is different from
Arch::Changeset::\fBget_changes\fR and Arch::Tree::\fBget_changes\fR.
.IP "\fBsplit_version\fR" 4
.IX Item "split_version"
Return a list of 2 strings: full version and patch-level.
.IP "\fBget_version\fR" 4
.IX Item "get_version"
Return the full version name, not unlike \fBsplit_version\fR.
.IP "\fBget_revision\fR" 4
.IX Item "get_revision"
Return the full revision name.  This is currently a concatination of
headers Archive and Revision with '/' separator.
.IP "\fBget_revision_kind\fR" 4
.IX Item "get_revision_kind"
Return one of the strings 'tag', 'import' or 'cset' depending on the
revision kind this log represents.
.IP "\fBget_revision_desc\fR" 4
.IX Item "get_revision_desc"
Return revision description hashref with the keys:
name, version, summary, creator, email, date, kind.
.IP "\fBdump\fR" 4
.IX Item "dump"
Returns the object dump using Data::Dumper.
.SH "BUGS"
.IX Header "BUGS"
Awaiting for your reports.
.SH "AUTHORS"
.IX Header "AUTHORS"
Mikhael Goikhman (migo@homemail.com\*(--Perl\-GPL/arch\-perl\*(--devel).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
For more information, see tla, Arch::Session, Arch::Library,
Arch::Changes.