On this page:
git_  note_  author
git_  note_  committer
git_  note_  create
git_  note_  foreach
git_  note_  free
git_  note_  id
git_  note_  iterator_  free
git_  note_  iterator_  new
git_  note_  message
git_  note_  next
git_  note_  read
git_  note_  remove
8.12

22 Note🔗ℹ

 (require libgit2/include/note) package: libgit2

procedure

(git_note_author note)  signature?

  note : note?
Get the note author

procedure

(git_note_committer note)  signature?

  note : note?
Get the note committer

procedure

(git_note_create out    
  repo    
  notes_ref    
  author    
  committer    
  oid    
  note    
  force)  integer?
  out : oid?
  repo : repository?
  notes_ref : (or/c string? #f)
  author : signature?
  committer : signature?
  oid : oid?
  note : string?
  force : boolean?
Add a note for an object

procedure

(git_note_foreach repo    
  notes_ref    
  note_cb    
  payload)  integer?
  repo : repository?
  notes_ref : string?
  note_cb : git_note_foreach_cb
  payload : bytes?
Loop over all the notes within a specified namespace and issue a callback for each one.

procedure

(git_note_free note)  void?

  note : note?
Free a git_note object

procedure

(git_note_id note)  oid?

  note : note?
Get the note object’s id

procedure

(git_note_iterator_free it)  void?

  it : note_iterator?
Frees an git_note_iterator

procedure

(git_note_iterator_new repo notes_ref)  note_iterator?

  repo : repository?
  notes_ref : string?
Creates a new iterator for notes

The iterator must be freed manually by the user.

procedure

(git_note_message note)  string?

  note : note?
Get the note message

procedure

(git_note_next note_id annotated_id it)  integer?

  note_id : oid?
  annotated_id : oid?
  it : note_iterator?
Return the current item (note_id and annotated_id) and advance the iterator internally to the next value

procedure

(git_note_read repo notes_ref oid)  note?

  repo : repository?
  notes_ref : (or/c string? #f)
  oid : oid?
Read the note for an object

The note must be freed manually by the user.

procedure

(git_note_remove repo    
  notes_ref    
  author    
  committer    
  oid)  integer?
  repo : repository?
  notes_ref : (or/c string? #f)
  author : signature?
  committer : signature?
  oid : oid?
Remove the note for an object