.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Git::Raw::Note 3pm"
.TH Git::Raw::Note 3pm 2024-03-07 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Git::Raw::Note \- Git note class
.SH VERSION
.IX Header "VERSION"
version 0.90
.SH DESCRIPTION
.IX Header "DESCRIPTION"
A Git::Raw::Note represents a git note.
.PP
\&\fBWARNING\fR: The API of this module is unstable and may change without warning
(any change will be appropriately documented in the changelog).
.SH METHODS
.IX Header "METHODS"
.ie n .SS "create( $repo, $commitish, $content, [$refname, $force] )"
.el .SS "create( \f(CW$repo\fP, \f(CW$commitish\fP, \f(CW$content\fP, [$refname, \f(CW$force\fP] )"
.IX Subsection "create( $repo, $commitish, $content, [$refname, $force] )"
Add a note for an object. \f(CW$refname\fR is the canonical name of the note
reference to use (defaults to \f(CW"refs/notes/commits"\fR). Returns a
Git::Raw::Note object.
.ie n .SS "read( $repo, $commitish, [$refname] )"
.el .SS "read( \f(CW$repo\fP, \f(CW$commitish\fP, [$refname] )"
.IX Subsection "read( $repo, $commitish, [$refname] )"
Read the note for \f(CW$commitish\fR. Returns a Git::Raw::Note object if a note
is associated with \f(CW$commitish\fR, otherwise \f(CW\*(C`undef\*(C'\fR.
.ie n .SS "remove( $repo, $commitish, [$refname] )"
.el .SS "remove( \f(CW$repo\fP, \f(CW$commitish\fP, [$refname] )"
.IX Subsection "remove( $repo, $commitish, [$refname] )"
Remove the note from \f(CW$commitish\fR.
.SS "id( )"
.IX Subsection "id( )"
Retrieve the note's id as a string.
.SS "message( )"
.IX Subsection "message( )"
Retrieve the note's message.
.SS "author( )"
.IX Subsection "author( )"
Retrieve the Git::Raw::Signature representing the author of the note.
.SS "committer( )"
.IX Subsection "committer( )"
Retrieve the Git::Raw::Signature representing the committer.
.ie n .SS "default_ref( $repo )"
.el .SS "default_ref( \f(CW$repo\fP )"
.IX Subsection "default_ref( $repo )"
Get the default notes reference for the repository. Returns a
Git::Raw::Reference object if the reference exists otherwise \f(CW\*(C`undef\*(C'\fR.
.SH AUTHOR
.IX Header "AUTHOR"
Jacques Germishuys <jacquesg@cpan.org>
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright 2014 Jacques Germishuys.
.PP
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.
.PP
See http://dev.perl.org/licenses/ for more information.