FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
libgit2/include/git2/notes.h at main · libgit2/libgit2 · GitHub
libgit2
/
libgit2
Public
Notifications
You must be signed in to change notification settings
Fork
2.7k
Star
10.6k
Code
Issues
430
Pull requests
133
Discussions
Actions
Projects
Security and quality
11
Insights
Additional navigation options
Code
Issues
Pull requests
Discussions
Actions
Projects
Security and quality
Insights
Expand file tree
Breadcrumbs
libgit2
/
include
/
git2
/
notes.h
Copy path
More file actions
More file actions
Latest commit
History
History
History
310 lines (283 loc) · 8.35 KB
Breadcrumbs
libgit2
/
include
/
git2
/
notes.h
Copy path
File metadata and controls
310 lines (283 loc) · 8.35 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
/*
* Copyright (C) the libgit2 contributors. All rights reserved.
*
* This file is part of libgit2, distributed under the GNU GPL v2 with
* a Linking Exception. For full terms see the included COPYING file.
*/
#ifndef
INCLUDE_git_note_h__
#define
INCLUDE_git_note_h__
#include
"oid.h"
#include
"types.h"
/**
* @file git2/notes.h
* @brief Notes are metadata attached to an object
* @defgroup git_note Git notes management routines
* @ingroup Git
* @{
*/
GIT_BEGIN_DECL
/**
* Callback for git_note_foreach.
*
* @param blob_id object id of the blob containing the message
* @param annotated_object_id the id of the object being annotated
* @param payload user-specified data to the foreach function
* @return 0 on success, or a negative number on failure
*/
typedef
int
GIT_CALLBACK
(
git_note_foreach_cb
)(
const
git_oid
*
blob_id
,
const
git_oid
*
annotated_object_id
,
void
*
payload
);
/**
* note iterator
*/
typedef
struct
git_iterator
git_note_iterator
;
/**
* Creates a new iterator for notes
*
* The iterator must be freed manually by the user.
*
* @param[out] out pointer to the iterator
* @param repo repository where to look up the note
* @param notes_ref canonical name of the reference to use (optional); defaults to
* "refs/notes/commits"
*
* @return 0 or an error code
*/
GIT_EXTERN
(
int
)
git_note_iterator_new
(
git_note_iterator
*
*
out
,
git_repository
*
repo
,
const
char
*
notes_ref
);
/**
* Creates a new iterator for notes from a commit
*
* The iterator must be freed manually by the user.
*
* @param[out] out pointer to the iterator
* @param notes_commit a pointer to the notes commit object
*
* @return 0 or an error code
*/
GIT_EXTERN
(
int
)
git_note_commit_iterator_new
(
git_note_iterator
*
*
out
,
git_commit
*
notes_commit
);
/**
* Frees an git_note_iterator
*
* @param it pointer to the iterator
*/
GIT_EXTERN
(
void
)
git_note_iterator_free
(
git_note_iterator
*
it
);
/**
* Return the current item (note_id and annotated_id) and advance the iterator
* internally to the next value
*
* @param note_id id of blob containing the message
* @param annotated_id id of the git object being annotated
* @param it pointer to the iterator
*
* @return 0 (no error), GIT_ITEROVER (iteration is done) or an error code
* (negative value)
*/
GIT_EXTERN
(
int
)
git_note_next
(
git_oid
*
note_id
,
git_oid
*
annotated_id
,
git_note_iterator
*
it
);
/**
* Read the note for an object
*
* The note must be freed manually by the user.
*
* @param[out] out pointer to the read note; NULL in case of error
* @param repo repository where to look up the note
* @param notes_ref canonical name of the reference to use (optional); defaults to
* "refs/notes/commits"
* @param oid OID of the git object to read the note from
*
* @return 0 or an error code
*/
GIT_EXTERN
(
int
)
git_note_read
(
git_note
*
*
out
,
git_repository
*
repo
,
const
char
*
notes_ref
,
const
git_oid
*
oid
);
/**
* Read the note for an object from a note commit
*
* The note must be freed manually by the user.
*
* @param[out] out pointer to the read note; NULL in case of error
* @param repo repository where to look up the note
* @param notes_commit a pointer to the notes commit object
* @param oid OID of the git object to read the note from
*
* @return 0 or an error code
*/
GIT_EXTERN
(
int
)
git_note_commit_read
(
git_note
*
*
out
,
git_repository
*
repo
,
git_commit
*
notes_commit
,
const
git_oid
*
oid
);
/**
* Get the note author
*
* @param note the note
* @return the author
*/
GIT_EXTERN
(
const
git_signature
*
)
git_note_author
(
const
git_note
*
note
);
/**
* Get the note committer
*
* @param note the note
* @return the committer
*/
GIT_EXTERN
(
const
git_signature
*
)
git_note_committer
(
const
git_note
*
note
);
/**
* Get the note message
*
* @param note the note
* @return the note message
*/
GIT_EXTERN
(
const
char
*
)
git_note_message
(
const
git_note
*
note
);
/**
* Get the note object's id
*
* @param note the note
* @return the note object's id
*/
GIT_EXTERN
(
const
git_oid
*
)
git_note_id
(
const
git_note
*
note
);
/**
* Add a note for an object
*
* @param out pointer to store the OID (optional); NULL in case of error
* @param repo repository where to store the note
* @param notes_ref canonical name of the reference to use (optional);
* defaults to "refs/notes/commits"
* @param author signature of the notes commit author
* @param committer signature of the notes commit committer
* @param oid OID of the git object to decorate
* @param note Content of the note to add for object oid
* @param force Overwrite existing note
*
* @return 0 or an error code
*/
GIT_EXTERN
(
int
)
git_note_create
(
git_oid
*
out
,
git_repository
*
repo
,
const
char
*
notes_ref
,
const
git_signature
*
author
,
const
git_signature
*
committer
,
const
git_oid
*
oid
,
const
char
*
note
,
int
force
);
/**
* Add a note for an object from a commit
*
* This function will create a notes commit for a given object,
* the commit is a dangling commit, no reference is created.
*
* @param notes_commit_out pointer to store the commit (optional);
* NULL in case of error
* @param notes_blob_out a point to the id of a note blob (optional)
* @param repo repository where the note will live
* @param parent Pointer to parent note
* or NULL if this shall start a new notes tree
* @param author signature of the notes commit author
* @param committer signature of the notes commit committer
* @param oid OID of the git object to decorate
* @param note Content of the note to add for object oid
* @param allow_note_overwrite Overwrite existing note
*
* @return 0 or an error code
*/
GIT_EXTERN
(
int
)
git_note_commit_create
(
git_oid
*
notes_commit_out
,
git_oid
*
notes_blob_out
,
git_repository
*
repo
,
git_commit
*
parent
,
const
git_signature
*
author
,
const
git_signature
*
committer
,
const
git_oid
*
oid
,
const
char
*
note
,
int
allow_note_overwrite
);
/**
* Remove the note for an object
*
* @param repo repository where the note lives
* @param notes_ref canonical name of the reference to use (optional);
* defaults to "refs/notes/commits"
* @param author signature of the notes commit author
* @param committer signature of the notes commit committer
* @param oid OID of the git object to remove the note from
*
* @return 0 or an error code
*/
GIT_EXTERN
(
int
)
git_note_remove
(
git_repository
*
repo
,
const
char
*
notes_ref
,
const
git_signature
*
author
,
const
git_signature
*
committer
,
const
git_oid
*
oid
);
/**
* Remove the note for an object
*
* @param notes_commit_out pointer to store the new notes commit (optional);
* NULL in case of error.
* When removing a note a new tree containing all notes
* sans the note to be removed is created and a new commit
* pointing to that tree is also created.
* In the case where the resulting tree is an empty tree
* a new commit pointing to this empty tree will be returned.
* @param repo repository where the note lives
* @param notes_commit a pointer to the notes commit object
* @param author signature of the notes commit author
* @param committer signature of the notes commit committer
* @param oid OID of the git object to remove the note from
*
* @return 0 or an error code
*/
GIT_EXTERN
(
int
)
git_note_commit_remove
(
git_oid
*
notes_commit_out
,
git_repository
*
repo
,
git_commit
*
notes_commit
,
const
git_signature
*
author
,
const
git_signature
*
committer
,
const
git_oid
*
oid
);
/**
* Free a git_note object
*
* @param note git_note object
*/
GIT_EXTERN
(
void
)
git_note_free
(
git_note
*
note
);
/**
* Get the default notes reference for a repository
*
* @param out buffer in which to store the name of the default notes reference
* @param repo The Git repository
*
* @return 0 or an error code
*/
GIT_EXTERN
(
int
)
git_note_default_ref
(
git_buf
*
out
,
git_repository
*
repo
);
/**
* Loop over all the notes within a specified namespace
* and issue a callback for each one.
*
* @param repo Repository where to find the notes.
*
* @param notes_ref Reference to read from (optional); defaults to
* "refs/notes/commits".
*
* @param note_cb Callback to invoke per found annotation. Return non-zero
* to stop looping.
*
* @param payload Extra parameter to callback function.
*
* @return 0 on success, non-zero callback return value, or error code
*/
GIT_EXTERN
(
int
)
git_note_foreach
(
git_repository
*
repo
,
const
char
*
notes_ref
,
git_note_foreach_cb
note_cb
,
void
*
payload
);
/** @} */
GIT_END_DECL
#endif
Back
|
FazBrowse Home
|
New Git URL