NAME

       Git::Raw::Note - Git note class

VERSION

       version 0.88

DESCRIPTION

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

AUTHOR

       Jacques Germishuys <jacquesg@striata.com>

LICENSE AND COPYRIGHT

       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.