git::repository::plugin::log(3pm) [debian man page]

Git::Repository::Plugin::Log(3pm)			User Contributed Perl Documentation			 Git::Repository::Plugin::Log(3pm)

NAME

       Git::Repository::Plugin::Log - Add a log() method to Git::Repository

SYNOPSIS

	   # load the plugin
	   use Git::Repository 'Log';

	   my $r = Git::Repository->new();

	   # get all log objects
	   my @logs = $r->log(qw( --since=yesterday ));

	   # get an iterator
	   my $iter = $r->log(qw( --since=yesterday ));
	   while ( my $log = $iter->next() ) {
	       ...;
	   }

DESCRIPTION

       This module adds a new method to "Git::Repository".

METHOD

   log( @args )
       Run "git log" with the given arguments.

       In scalar context, returns a "Git::Repository::Log::Iterator" object, which can return "Git::Repository::Log" objects on demand.

       In list context, returns the full list "Git::Repository::Log" objects.  Note that this can be very memory-intensive.

       See Git::Repository::Log::Iterator's documentation for details about how parameters are handled.

AUTHOR

       Philippe Bruhat (BooK), "<book at cpan.org>"

ACKNOWLEDGEMENTS

       Many thanks to Aristotle Pagaltzis who requested a "log()" method in the first place, and for very interesting conversations on the topic.

SEE ALSO

       Git::Repository::Plugin, Git::Repository::Log::Iterator, Git::Repository::Log.

COPYRIGHT

       Copyright 2010 Philippe Bruhat (BooK).

LICENSE

       This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.14.2							    2011-12-28					 Git::Repository::Plugin::Log(3pm)

Git::Repository::Log(3pm)				User Contributed Perl Documentation				 Git::Repository::Log(3pm)

NAME

       Git::Repository::Log - Class representing git log data

SYNOPSIS

	   # load the Log plugin
	   use Git::Repository 'Log';

	   # get the log for last commit
	   my ($log) = Git::Repository->log( '-1' );

	   # get the author's email
	   print my $email = $log->author_email;

DESCRIPTION

       "Git::Repository::Log" is a class whose instances reprensent log items from a git log stream.

CONSTRUCTOR

       This method shouldn't be used directly. "Git::Repository::Log::Iterator" should be the preferred way to create "Git::Repository::Log"
       objects.

   new( @args )
       Create a new "Git::Repository::Log" instance, using the list of key/values passed as parameters. The supported keys are (from the output of
       "git log --pretty=raw"):

       commit
	   The commit id (ignore the extra information added by --decorate).

       tree
	   The tree id.

       parent
	   The parent list, separated by spaces.

       author
	   The author information.

       committer
	   The committer information.

       message
	   The log message (including the 4-space indent normally output by git log).

       extra
	   Any extra text that might be added by extra options passed to git log.

ACCESSORS

       The following accessors methods are recognized. They all return scalars, except for "parent()", which returns a list.

   Commit information
       commit
       tree
       parent

   Author and committer information
       author
       committer
	   The original author/committer line

       author_name
       committer_name
       author_email
       committer_email

   Date information
       author_gmtime
       committer_gmtime
       author_localtime
       committer_localtime
       author_tz
       committer_tz

   Log information
       raw_message
	   The log message with the 4-space indent output by git log.

       message
	   The unindented version of the log message.

       subject
       body

   Extra information
       extra

AUTHOR

       Philippe Bruhat (BooK), "<book at cpan.org>"

COPYRIGHT

       Copyright 2010 Philippe Bruhat (BooK), all rights reserved.

LICENSE

       This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.14.2							    2011-12-28						 Git::Repository::Log(3pm)