libgit2

git_note_commit_remove

Version:

Remove the note for an object

Signature

GitHub
int git_note_commit_remove(git_oid *notes_commit_out, git_repository *repo, git_commit *notes_commit, const git_signature *author, const git_signature *committer, const git_oid *oid);

Parameters

git_oid *
In
notes_commit_out

pointer to store the new notes commit (optional); NULL in case of error. When removing a note a new tree containing all notes sans the note to be removed is created and a new commit pointing to that tree is also created. In the case where the resulting tree is an empty tree a new commit pointing to this empty tree will be returned.

git_repository *
In
repo

repository where the note lives

git_commit *
In
notes_commit

a pointer to the notes commit object

const git_signature *
In
author

signature of the notes commit author

const git_signature *
In
committer

signature of the notes commit committer

const git_oid *
In
oid

OID of the git object to remove the note from

Returns

int

0 or an error code

Versions