libgit2

git_commit_create

Version:

Create new commit in the repository from a list of git_object pointers

The message will not be cleaned up automatically. You can do that with the git_message_prettify() function.

Signature

GitHub
int git_commit_create(git_oid *id, git_repository *repo, const char *update_ref, const git_signature *author, const git_signature *committer, const char *message_encoding, const char *message, const git_tree *tree, size_t parent_count, const git_commit **parents);

Parameters

git_oid *
In
id

Pointer in which to store the OID of the newly created commit

git_repository *
In
repo

Repository where to store the commit

const char *
In
update_ref

If not NULL, name of the reference that will be updated to point to this commit. If the reference is not direct, it will be resolved to a direct reference. Use "HEAD" to update the HEAD of the current branch and make it point to this commit. If the reference doesn't exist yet, it will be created. If it does exist, the first parent must be the tip of this branch.

const git_signature *
In
author

Signature with author and author time of commit

const git_signature *
In
committer

Signature with committer and * commit time of commit

const char *
In
message_encoding

The encoding for the message in the commit, represented with a standard encoding name. E.g. "UTF-8". If NULL, no encoding header is written and UTF-8 is assumed.

const char *
In
message

Full message for this commit

const git_tree *
In
tree

An instance of a git_tree object that will be used as the tree for the commit. This tree object must also be owned by the given repo.

size_t
In
parent_count

Number of parents for this commit

const git_commit **
In
parents

Array of parent_count pointers to git_commit objects that will be used as the parents for this commit. This array may be NULL if parent_count is 0 (root commit). All the given commits must be owned by the repo.

Returns

int

0 or an error code The created commit will be written to the Object Database and the given reference will be updated to point to it

Versions