.\" Automatically generated by Pod::Man 4.10 (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
..
.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::Walker 3pm"
.TH Git::Raw::Walker 3pm "2019-01-12" "perl v5.28.1" "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::Walker \- Git revwalker 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);
\&
\&    # create a new walker
\&    my $log  = $repo \-> walker;
\&
\&    # push the head of the repository
\&    $log \-> push_head;
\&
\&    # print all commit messages
\&    while (my $commit = $log \-> next) {
\&      say $commit \-> message;
\&    }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A Git::Raw::Walker represents a graph walker used to walk through the
repository's revisions (sort of like \f(CW\*(C`git log\*(C'\fR).
.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 "create( $repo )"
.el .SS "create( \f(CW$repo\fP )"
.IX Subsection "create( $repo )"
Create a new revision walker.
.SS "sorting( \e@order )"
.IX Subsection "sorting( @order )"
Change the sorting mode when iterating through the repository's contents.
Values for \f(CW@order\fR may be one or more of the following:
.IP "\(bu" 4
\&\*(L"none\*(R"
.Sp
Sort the repository contents in no particular ordering, that is, sorting is
arbitrary, implementation-specific and subject to change at any time. (Default)
.IP "\(bu" 4
\&\*(L"topological\*(R"
.Sp
Sort the repository contents in topological order (parents before children).
This sorting mode may be combined with time sorting.
.IP "\(bu" 4
\&\*(L"time\*(R"
.Sp
Sort the repository contents by commit time. This sorting mode may be combined
with topological sorting.
.IP "\(bu" 4
\&\*(L"reverse\*(R"
.Sp
Iterate through the repository contents in reverse order. This sorting mode may
be combined with any of the above.
.ie n .SS "push( $commit )"
.el .SS "push( \f(CW$commit\fP )"
.IX Subsection "push( $commit )"
Push a Git::Raw::Commit to the list of commits to be used as roots when
starting a revision walk.
.ie n .SS "push_glob( $glob )"
.el .SS "push_glob( \f(CW$glob\fP )"
.IX Subsection "push_glob( $glob )"
Push references by \f(CW$glob\fR to the list of commits to be used as roots when
starting a revision walk.
.ie n .SS "push_ref( $name )"
.el .SS "push_ref( \f(CW$name\fP )"
.IX Subsection "push_ref( $name )"
Push a reference by \f(CW$name\fR to the list of commits to be used as roots when
starting a revision walk.
.SS "push_head( )"
.IX Subsection "push_head( )"
Push \s-1HEAD\s0 of the repository to the list of commits to be used as roots when
starting a revision walk.
.ie n .SS "push_range( $start, $end )"
.el .SS "push_range( \f(CW$start\fP, \f(CW$end\fP )"
.IX Subsection "push_range( $start, $end )"
Push and hide the respective endpoints of the given range. \f(CW$start\fR and \f(CW$end\fR
should be \f(CW"commitish"\fR, that is, it should be a Git::Raw::Commit or
Git::Raw::Reference object, or alternatively a commit id or commit id prefix.
.ie n .SS "push_range( $range )"
.el .SS "push_range( \f(CW$range\fP )"
.IX Subsection "push_range( $range )"
Push and hide the respective endpoints of the given range. \f(CW$range\fR should be
of the form \f(CW"start_commit_id..end_commit_id"\fR.
.ie n .SS "hide( $commit )"
.el .SS "hide( \f(CW$commit\fP )"
.IX Subsection "hide( $commit )"
Hide a Git::Raw::Commit and its ancestors from the walker.
.ie n .SS "hide_glob( $glob )"
.el .SS "hide_glob( \f(CW$glob\fP )"
.IX Subsection "hide_glob( $glob )"
Hide references by \f(CW$glob\fR and all ancestors from the walker.
.ie n .SS "hide_ref( $name )"
.el .SS "hide_ref( \f(CW$name\fP )"
.IX Subsection "hide_ref( $name )"
Hide a reference by \f(CW$name\fR and its ancestors from the walker.
.SS "hide_head( )"
.IX Subsection "hide_head( )"
Hide \s-1HEAD\s0 of the repository and its ancestors from the walker.
.SS "next( )"
.IX Subsection "next( )"
Retrieve the next commit from the revision walk. Returns a Git::Raw::Commit
object or \f(CW\*(C`undef\*(C'\fR if there are no commits.
.SS "all( )"
.IX Subsection "all( )"
Retrieve all commits. Returns a list of Git::Raw::Commit objects.
.SS "reset( )"
.IX Subsection "reset( )"
Reset the revision walker (this is done automatically at the end of a walk).
.SH "AUTHOR"
.IX Header "AUTHOR"
Alessandro Ghedini <alexbio@cpan.org>
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright 2012 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.