Module gall.commit

Commit object interface

Functions

create (repo, data) Create a new commit object in the repository.
new (repo, obj) Instantiate a new commit object for the given raw git object

Class whowhen

whowhen.email The email address of the person.
whowhen.realname The “real” name of the person.
whowhen.timezone The timezone in which the signature took place (+/-HHHH)
whowhen.unixtime The UNIX time (seconds since epoch) for the signature line

Class commit

commit.author The author of the commit as a whowhen object
commit.committer The committer of the commit as a whowhen object
commit.message The commit message
commit.parents The parents of the commit (zero or more commit objects)
commit.sha The SHA1 OID of the commit
commit.signature The signature on the commit (if present)
commit.signedcert The certificate which the signature (if present) signs
commit.tree The tree object referenced by this commit.


Functions

create (repo, data)

Create a new commit object in the repository.

The given data must contain all of:

  • tree - The tree object for the commit
  • author - The author (as a table of realname and email)
  • committer - The committer (as a table of realname and email)
  • message - The commit message

It may optionally contain:

  • parents - The list of parent commit objects.

Parameters:

  • repo repository The repository to create the commit in
  • data table The commit data

Returns:

    commit The newly added commit object

Or

  1. nil Nil on error
  2. string The error message
new (repo, obj)
Instantiate a new commit object for the given raw git object

Parameters:

  • repo repository The repository containing the commit
  • obj object The raw git object for the commit

Returns:

    commit The new commit instance

Class whowhen

Who, when Encapsulation of git’s author/committer who and when data
whowhen.email
The email address of the person.
  • email
whowhen.realname
The “real” name of the person.
  • realname
whowhen.timezone
The timezone in which the signature took place (+/-HHHH)
  • timezone
whowhen.unixtime
The UNIX time (seconds since epoch) for the signature line
  • unixtime

Class commit

Commit object.
commit.author
The author of the commit as a whowhen object
  • author
commit.committer
The committer of the commit as a whowhen object
  • committer
commit.message
The commit message
  • message
commit.parents
The parents of the commit (zero or more commit objects)
  • parents
commit.sha
The SHA1 OID of the commit
  • sha
commit.signature
The signature on the commit (if present)
  • signature
commit.signedcert
The certificate which the signature (if present) signs
  • signedcert
commit.tree
The tree object referenced by this commit.
  • tree

See also:

generated by LDoc 1.4.3 Last updated 2016-10-27 06:21:07