Git::Raw::Note(3pm)

Git::Raw::Note3pm

Git note class

Version

version 0.90

Overview

A Git::Raw::Note represents a git note.

WARNING: The API of this module is unstable and may change without warning (any change will be appropriately documented in the changelog).

Methods

create( $repo, $commitish, $content, [$refname, $force] )

Add a note for an object. $refname is the canonical name of the note reference to use (defaults to "refs/notes/commits"). Returns a Git::Raw::Note object.

read( $repo, $commitish, [$refname] )

Read the note for $commitish. Returns a Git::Raw::Note object if a note is associated with $commitish, otherwise "undef".

remove( $repo, $commitish, [$refname] )

Remove the note from $commitish.

id( )

Retrieve the note's id as a string.

message( )

Retrieve the note's message.

author( )

Retrieve the Git::Raw::Signature representing the author of the note.

committer( )

Retrieve the Git::Raw::Signature representing the committer.

default_ref( $repo )

Get the default notes reference for the repository. Returns a Git::Raw::Reference object if the reference exists otherwise "undef".

Releases

4 releases since Debian 10 (Buster); the text changed 3 times.

  1. 10
  2. 11
  3. 12
  4. 13

Author

Jacques Germishuys <[email protected]>

From libgit-raw-perl 0.90+ds-3+b1 in Debian 13 (Trixie). Parsed by carta from the page's man source.