Method

GgitRepositorycreate_note

Declaration [src]

GgitOId*
ggit_repository_create_note (
  GgitRepository* repository,
  const gchar* notes_ref,
  GgitSignature* author,
  GgitSignature* committer,
  GgitOId* id,
  const gchar* note,
  gboolean force,
  GError** error
)

Description [src]

Adds a note for an object.

Parameters

`notes_ref`	`const gchar*`
	Canonical name of the reference to use, or `NULL` to use the default ref.
	The argument can be `NULL`.
	The data is owned by the caller of the function.
	The value is a NUL terminated UTF-8 string.
`author`	`GgitSignature`
	Author signature.
	The data is owned by the caller of the function.
`committer`	`GgitSignature`
	Committer signature.
	The data is owned by the caller of the function.
`id`	`GgitOId`
	OID of the git object to decorate.
	The data is owned by the caller of the function.
`note`	`const gchar*`
	Content of the note to add for object oid.
	The data is owned by the caller of the function.
	The value is a NUL terminated UTF-8 string.
`force`	`gboolean`
	Whether to overwrite existing note.
`error`	`GError **`
	The return location for a `GError*`, or `NULL`.

Return value

Returns:	`GgitOId`
	The OID for the note or `NULL` in case of error.
	The caller of the method takes ownership of the data, and is responsible for freeing it.
	The return value can be `NULL`.