DOKK / manpages / debian 12 / libgit-raw-perl / Git::Raw::Note.3pm.en
Git::Raw::Note(3pm) User Contributed Perl Documentation Git::Raw::Note(3pm)

Git::Raw::Note - Git note class

version 0.90

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).

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 the note for $commitish. Returns a Git::Raw::Note object if a note is associated with $commitish, otherwise "undef".

Remove the note from $commitish.

Retrieve the note's id as a string.

Retrieve the note's message.

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

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

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

Jacques Germishuys <jacquesg@cpan.org>

Copyright 2014 Jacques Germishuys.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.

2022-10-29 perl v5.36.0