[ Web Proxy ]
URL:
Viewing: https://libgit2.org/docs/reference/v1.8.2/notes/git_note_commit_remove.html [Back]  [Original]
git_note_commit_remove (libgit2 v1.8.2)
libgit2 [libgit2]

git_note_commit_remove

Version: main v1.8.4 v1.8.3 v1.8.2 v1.8.2-rc1 v1.8.1 v1.8.0 v1.7.2 v1.7.1 v1.7.0 v1.6.5 v1.6.4 v1.6.3 v1.6.2 v1.6.1 v1.5.2 v1.5.1 v1.5.0 v1.4.6 v1.4.5 v1.4.4 v1.4.3 v1.4.2 v1.4.1 v1.4.0 v1.3.2 v1.3.1 v1.3.0 v1.2.0 v1.1.1 v1.1.0 v1.0.1 v1.0.0 v0.99.0 v0.28.5 v0.28.4 v0.28.3 v0.28.2 v0.28.1 v0.28.0 v0.28.0-rc1 v0.27.10 v0.27.9 v0.27.8 v0.27.7 v0.27.6 v0.27.5 v0.27.4 v0.27.3 v0.27.2 v0.27.1 v0.27.0 v0.27.0-rc3 v0.27.0-rc2 v0.27.0-rc1

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

This open sourced site is hosted on GitHub. Patches, suggestions, and comments are welcome.
Web Proxy Viewer  |  New URL  |  Original Page