2.24 Note

7.7

top ← prev up next →

2.24 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

top ← prev up next →

1	Background
2	Functions
	Bibliography
	Index

2.1	Annotated Commit
2.2	Blame
2.3	Blob
2.4	Branch
2.5	Buffer
2.6	Checkout
2.7	Cherrypick
2.8	Clone
2.9	Commit
2.10	Config
2.11	Credentials
2.12	Describe
2.13	Diff
2.14	Fetch
2.15	Filter
2.16	Errors
2.17	Graph
2.18	Ignore
2.19	Index
2.20	Indexer
2.21	Global
2.22	Merge
2.23	Message
2.24	Note
2.25	Object
2.26	Object Database
2.27	Oid
2.28	Oid Array
2.29	Packbuilder
2.30	Patch
2.31	Pathspec
2.32	Proxy
2.33	Push
2.34	Rebase
2.35	Refdb
2.36	Reference
2.37	Reflog
2.38	Refspec
2.39	Remote
2.40	Repository
2.41	Reset
2.42	Revert
2.43	Revparse
2.44	Revwalk
2.45	Signature
2.46	Stash
2.47	Status
2.48	Strarray
2.49	Submodule
2.50	Tag
2.51	Tree
2.52	Treebuilder