Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

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

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)

Check Out this Related Man Page

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

NAME

       Git::Repository::Log::Iterator - Split a git log stream into records

SYNOPSIS

	   use Git::Repository::Log::Iterator;

	   # use a default Git::Repository context
	   my $iter = Git::Repository::Log::Iterator->new('HEAD~10..');

	   # or provide an existing instance
	   my $iter = Git::Repository::Log::Iterator->new( $r, 'HEAD~10..' );

	   # get the next log record
	   while ( my $log = $iter->next ) {
	       ...;
	   }

DESCRIPTION

       "Git::Repository::Log::Iterator" initiates a git log command from a list of paramaters and parses its output to produce
       "Git::Repository::Log" objects represening each log item.

METHODS

   new( @args )
       Create a new git log stream from the parameter list in @args and return a iterator on it.

       "new()" will happily accept any parameters, but note that "Git::Repository::Log::Iterator" expects the output to look like that of
       "--pretty=raw", and so will force the the "--pretty" option (in case "format.pretty" is defined in the Git configuration).

       Extra output (like patches) will be stored in the "extra" parameter of the "Git::Repository::Log" object. Decorations will be lost.

       When unsupported options are recognized in the parameter list, "new()" will "croak()" with a message advising to use "run( 'log' => ... )"
       to parse the output yourself.

   next()
       Return the next log item as a "Git::Repository::Log" object, or nothing if the stream has ended.

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::Iterator(3pm)
Man Page