]>
Commit | Line | Data |
---|---|---|
159061a8 CMN |
1 | v0.23 + 1 |
2 | ------- | |
3 | ||
4 | ### Changes or improvements | |
5 | ||
9a99ca7b ET |
6 | * Custom filters can now be registered with wildcard attributes, for |
7 | example `filter=*`. Consumers should examine the attributes parameter | |
8 | of the `check` function for details. | |
9 | ||
d83b2e9f CMN |
10 | * Symlinks are now followed when locking a file, which can be |
11 | necessary when multiple worktrees share a base repository. | |
12 | ||
159061a8 CMN |
13 | ### API additions |
14 | ||
5340d63d CMN |
15 | * `git_config_lock()` has been added, which allow for |
16 | transactional/atomic complex updates to the configuration, removing | |
17 | the opportunity for concurrent operations and not committing any | |
18 | changes until the unlock. | |
36f784b5 | 19 | |
7fafde63 | 20 | |
3138ad93 JH |
21 | * `git_diff_options` added a new callback `progress_cb` to report on the |
22 | progress of the diff as files are being compared. The documentation of | |
23 | the existing callback `notify_cb` was updated to reflect that it only | |
24 | gets called when new deltas are added to the diff. | |
25 | ||
7fafde63 CMN |
26 | * `git_stream_register_tls()` lets you register a callback to be used |
27 | as the constructor for a TLS stream instead of the libgit2 built-in | |
28 | one. | |
29 | ||
159061a8 CMN |
30 | ### API removals |
31 | ||
79698030 ET |
32 | ### Breaking API changes |
33 | ||
34 | * `git_cert` descendent types now have a proper `parent` member | |
35 | ||
fec4a68c | 36 | * It is the responsibility of the refdb backend to decide what to do |
01d0c02d CMN |
37 | with the reflog on ref deletion. The file-based backend must delete |
38 | it, a database-backed one may wish to archive it. | |
39 | ||
36f784b5 CMN |
40 | * `git_config_backend` has gained two entries. `lock` and `unlock` |
41 | with which to implement the transactional/atomic semantics for the | |
42 | configuration backend. | |
43 | ||
a32bc85e ET |
44 | * `git_index_add` will now use the case as provided by the caller on |
45 | case insensitive systems. Previous versions would keep the case as | |
46 | it existed in the index. This does not affect the higher-level | |
47 | `git_index_add_bypath` or `git_index_add_frombuffer` functions. | |
48 | ||
3138ad93 JH |
49 | * The `notify_payload` field of `git_diff_options` was renamed to `payload` |
50 | to reflect that it's also the payload for the new progress callback. | |
51 | ||
159061a8 | 52 | v0.23 |
c8b64f70 CMN |
53 | ------ |
54 | ||
16bcf0c7 CMN |
55 | ### Changes or improvements |
56 | ||
70b0f128 JG |
57 | * Patience and minimal diff drivers can now be used for merges. |
58 | ||
59 | * Merges can now ignore whitespace changes. | |
60 | ||
0161e096 SS |
61 | * Updated binary identification in CRLF filtering to avoid false positives in |
62 | UTF-8 files. | |
63 | ||
4d6f55ac ET |
64 | * Rename and copy detection is enabled for small files. |
65 | ||
96b82b11 ET |
66 | * Checkout can now handle an initial checkout of a repository, making |
67 | `GIT_CHECKOUT_SAFE_CREATE` unnecessary for users of clone. | |
68 | ||
659cf202 CMN |
69 | * The signature parameter in the ref-modifying functions has been |
70 | removed. Use `git_repository_set_ident()` and | |
71 | `git_repository_ident()` to override the signature to be used. | |
72 | ||
0ef54a63 CMN |
73 | * The local transport now auto-scales the number of threads to use |
74 | when creating the packfile instead of sticking to one. | |
75 | ||
8acf058f CMN |
76 | * Reference renaming now uses the right id for the old value. |
77 | ||
78 | * The annotated version of branch creation, HEAD detaching and reset | |
79 | allow for specifying the expression from the user to be put into the | |
80 | reflog. | |
81 | ||
aa9bb425 | 82 | * `git_rebase_commit` now returns `GIT_EUNMERGED` when you attempt to |
eaf0d688 ET |
83 | commit with unstaged changes. |
84 | ||
85247df0 | 85 | * On Mac OS X, we now use SecureTransport to provide the cryptographic |
ca2466ff | 86 | support for HTTPS connections insead of OpenSSL. |
85247df0 | 87 | |
1f1f5c63 ET |
88 | * Checkout can now accept an index for the baseline computations via the |
89 | `baseline_index` member. | |
90 | ||
b1ae3e53 CMN |
91 | * The configuration for fetching is no longer stored inside the |
92 | `git_remote` struct but has been moved to a `git_fetch_options`. The | |
93 | remote functions now take these options or the callbacks instead of | |
94 | setting them beforehand. | |
95 | ||
ca2466ff CMN |
96 | * `git_submodule` instances are no longer cached or shared across |
97 | lookup. Each submodule represents the configuration at the time of | |
98 | loading. | |
99 | ||
874cc35a CMN |
100 | * The index now uses diffs for `add_all()` and `update_all()` which |
101 | gives it a speed boost and closer semantics to git. | |
102 | ||
e3435673 CMN |
103 | * The ssh transport now reports the stderr output from the server as |
104 | the error message, which allows you to get the "repository not | |
105 | found" messages. | |
106 | ||
ecd60a56 ET |
107 | * `git_index_conflict_add()` will remove staged entries that exist for |
108 | conflicted paths. | |
b1ae3e53 | 109 | |
10549a2d ET |
110 | * The flags for a `git_diff_file` will now have the `GIT_DIFF_FLAG_EXISTS` |
111 | bit set when a file exists on that side of the diff. This is useful | |
112 | for understanding whether a side of the diff exists in the presence of | |
113 | a conflict. | |
b1ae3e53 | 114 | |
a5670d4f CMN |
115 | * The constructor for a write-stream into the odb now takes |
116 | `git_off_t` instead of `size_t` for the size of the blob, which | |
117 | allows putting large files into the odb on 32-bit systems. | |
118 | ||
771069e1 PS |
119 | * The remote's push and pull URLs now honor the url.$URL.insteadOf |
120 | configuration. This allows modifying URL prefixes to a custom | |
121 | value via gitconfig. | |
122 | ||
0e522f6e ET |
123 | * `git_diff_foreach`, `git_diff_blobs`, `git_diff_blob_to_buffer`, |
124 | and `git_diff_buffers` now accept a new binary callback of type | |
125 | `git_diff_binary_cb` that includes the binary diff information. | |
126 | ||
bb4896f2 CMN |
127 | * The race condition mitigations described in `racy-git.txt` have been |
128 | implemented. | |
129 | ||
ede517bc CMN |
130 | * If libcurl is installed, we will use it to connect to HTTP(S) |
131 | servers. | |
132 | ||
16bcf0c7 CMN |
133 | ### API additions |
134 | ||
70b0f128 JG |
135 | * The `git_merge_options` gained a `file_flags` member. |
136 | ||
eac773d9 CMN |
137 | * Parsing and retrieving a configuration value as a path is exposed |
138 | via `git_config_parse_path()` and `git_config_get_path()` | |
139 | respectively. | |
140 | ||
659cf202 CMN |
141 | * `git_repository_set_ident()` and `git_repository_ident()` serve to |
142 | set and query which identity will be used when writing to the | |
143 | reflog. | |
144 | ||
9a97f49e CMN |
145 | * `git_config_entry_free()` frees a config entry. |
146 | ||
147 | * `git_config_get_string_buf()` provides a way to safely retrieve a | |
148 | string from a non-snapshot configuration. | |
149 | ||
8acf058f CMN |
150 | * `git_annotated_commit_from_revspec()` allows to get an annotated |
151 | commit from an extended sha synatx string. | |
152 | ||
153 | * `git_repository_set_head_detached_from_annotated()`, | |
154 | `git_branch_create_from_annotated()` and | |
155 | `git_reset_from_annotated()` allow for the caller to provide an | |
156 | annotated commit through which they can control what expression is | |
157 | put into the reflog as the source/target. | |
d578b45f | 158 | |
a275fbc0 | 159 | * `git_index_add_frombuffer()` can now create a blob from memory |
b1ae3e53 CMN |
160 | buffer and add it to the index which is attached to a repository. |
161 | ||
162 | * The structure `git_fetch_options` has been added to determine the | |
163 | runtime configuration for fetching, such as callbacks, pruning and | |
164 | autotag behaviour. It has the runtime initializer | |
165 | `git_fetch_init_options()`. | |
166 | ||
167 | * The enum `git_fetch_prune_t` has been added, letting you specify the | |
168 | pruning behaviour for a fetch. | |
a275fbc0 | 169 | |
a5670d4f CMN |
170 | * A push operation will notify the caller of what updates it indends |
171 | to perform on the remote, which provides similar information to | |
172 | git's pre-push hook. | |
173 | ||
15fdf054 ET |
174 | * `git_stash_apply()` can now apply a stashed state from the stash list, |
175 | placing the data into the working directory and index. | |
176 | ||
177 | * `git_stash_pop()` will apply a stashed state (like `git_stash_apply()`) | |
178 | but will remove the stashed state after a successful application. | |
179 | ||
1396c381 CMN |
180 | * A new error code `GIT_EEOF` indicates an early EOF from the |
181 | server. This typically indicates an error with the URL or | |
182 | configuration of the server, and tools can use this to show messages | |
183 | about failing to communicate with the server. | |
184 | ||
3cf91d98 CMN |
185 | * A new error code `GIT_EINVALID` indicates that an argument to a |
186 | function is invalid, or an invalid operation was requested. | |
187 | ||
7c948014 ET |
188 | * `git_diff_index_to_workdir()` and `git_diff_tree_to_index()` will now |
189 | produce deltas of type `GIT_DELTA_CONFLICTED` to indicate that the index | |
190 | side of the delta is a conflict. | |
191 | ||
192 | * The `git_status` family of functions will now produce status of type | |
193 | `GIT_STATUS_CONFLICTED` to indicate that a conflict exists for that file | |
194 | in the index. | |
195 | ||
9f545b9d ET |
196 | * `git_index_entry_is_conflict()` is a utility function to determine if |
197 | a given index entry has a non-zero stage entry, indicating that it is | |
198 | one side of a conflict. | |
199 | ||
a5670d4f CMN |
200 | * It is now possible to pass a keypair via a buffer instead of a |
201 | path. For this, `GIT_CREDTYPE_SSH_MEMORY` and | |
202 | `git_cred_ssh_key_memory_new()` have been added. | |
203 | ||
2eecc288 ET |
204 | * `git_filter_list_contains` will indicate whether a particular |
205 | filter will be run in the given filter list. | |
206 | ||
a3f42fe8 CMN |
207 | * `git_commit_header_field()` has been added, which allows retrieving |
208 | the contents of an arbitrary header field. | |
209 | ||
ca2466ff CMN |
210 | * `git_submodule_set_branch()` allows to set the configured branch for |
211 | a submodule. | |
212 | ||
16bcf0c7 CMN |
213 | ### API removals |
214 | ||
9663d1bd | 215 | * `git_remote_save()` and `git_remote_clear_refspecs()` have been |
b1ae3e53 CMN |
216 | removed. Remote's configuration is changed via the configuration |
217 | directly or through a convenience function which performs changes to | |
218 | the configuration directly. | |
219 | ||
220 | * `git_remote_set_callbacks()`, `git_remote_get_callbacks()` and | |
9663d1bd | 221 | `git_remote_set_transport()` have been removed and the remote no |
b1ae3e53 CMN |
222 | longer stores this configuration. |
223 | ||
70f7484d CMN |
224 | * `git_remote_set_fetch_refpecs()` and |
225 | `git_remote_set_push_refspecs()` have been removed. There is no | |
226 | longer a way to set the base refspecs at run-time. | |
227 | ||
ca2466ff CMN |
228 | * `git_submodule_save()` has been removed. The submodules are no |
229 | longer configured via the objects. | |
230 | ||
34065968 CMN |
231 | * `git_submodule_reload_all()` has been removed as we no longer cache |
232 | submodules. | |
233 | ||
16bcf0c7 CMN |
234 | ### Breaking API changes |
235 | ||
bf2ba529 JM |
236 | * `git_smart_subtransport_cb` now has a `param` parameter. |
237 | ||
70b0f128 JG |
238 | * The `git_merge_options` structure member `flags` has been renamed |
239 | to `tree_flags`. | |
240 | ||
b8c50808 | 241 | * The `git_merge_file_options` structure member `flags` is now |
70b0f128 JG |
242 | an unsigned int. It was previously a `git_merge_file_flags_t`. |
243 | ||
96b82b11 ET |
244 | * `GIT_CHECKOUT_SAFE_CREATE` has been removed. Most users will generally |
245 | be able to switch to `GIT_CHECKOUT_SAFE`, but if you require missing | |
246 | file handling during checkout, you may now use `GIT_CHECKOUT_SAFE | | |
247 | GIT_CHECKOUT_RECREATE_MISSING`. | |
248 | ||
41513659 CMN |
249 | * The `git_clone_options` and `git_submodule_update_options` |
250 | structures no longer have a `signature` field. | |
251 | ||
252 | * The following functions have removed the signature and/or log message | |
253 | parameters in favour of git-emulating ones. | |
254 | ||
255 | * `git_branch_create()`, `git_branch_move()` | |
256 | * `git_rebase_init()`, `git_rebase_abort()` | |
257 | * `git_reference_symbolic_create_matching()`, | |
258 | `git_reference_symbolic_create()`, `git_reference_create()`, | |
259 | `git_reference_create_matching()`, | |
260 | `git_reference_symbolic_set_target()`, | |
261 | `git_reference_set_target()`, `git_reference_rename()` | |
262 | * `git_remote_update_tips()`, `git_remote_fetch()`, `git_remote_push()` | |
263 | * `git_repository_set_head()`, | |
264 | `git_repository_set_head_detached()`, | |
265 | `git_repository_detach_head()` | |
266 | * `git_reset()` | |
267 | ||
9a97f49e CMN |
268 | * `git_config_get_entry()` now gives back a ref-counted |
269 | `git_config_entry`. You must free it when you no longer need it. | |
270 | ||
271 | * `git_config_get_string()` will return an error if used on a | |
272 | non-snapshot configuration, as there can be no guarantee that the | |
273 | returned pointer is valid. | |
274 | ||
385449b1 CMN |
275 | * `git_note_default_ref()` now uses a `git_buf` to return the string, |
276 | as the string is otherwise not guaranteed to stay allocated. | |
277 | ||
30640aa9 ET |
278 | * `git_rebase_operation_current()` will return `GIT_REBASE_NO_OPERATION` |
279 | if it is called immediately after creating a rebase session but before | |
280 | you have applied the first patch. | |
281 | ||
a5670d4f CMN |
282 | * `git_rebase_options` now contains a `git_checkout_options` struct |
283 | that will be used for functions that modify the working directory, | |
284 | namely `git_checkout_init`, `git_checkout_next` and | |
285 | `git_checkout_abort`. As a result, `git_rebase_open` now also takes | |
286 | a `git_rebase_options` and only the `git_rebase_init` and | |
f3a199dd ET |
287 | `git_rebase_open` functions take a `git_rebase_options`, where they |
288 | will persist the options to subsequent `git_rebase` calls. | |
289 | ||
b1ae3e53 CMN |
290 | * The `git_clone_options` struct now has fetch options in a |
291 | `fetch_opts` field instead of remote callbacks in | |
292 | `remote_callbacks`. | |
293 | ||
a5670d4f CMN |
294 | * The remote callbacks has gained a new member `push_negotiation` |
295 | which gets called before sending the update commands to the server. | |
296 | ||
ca2466ff | 297 | * The following functions no longer act on a remote instance but |
b1ae3e53 CMN |
298 | change the repository's configuration. Their signatures have changed |
299 | accordingly: | |
300 | ||
301 | * `git_remote_set_url()`, `git_remote_seturl()` | |
302 | * `git_remote_add_fetch()`, `git_remote_add_push()` and | |
303 | * `git_remote_set_autotag()` | |
304 | ||
305 | * `git_remote_connect()` and `git_remote_prune()` now take a pointer | |
306 | to the callbacks. | |
307 | ||
9663d1bd | 308 | * `git_remote_fetch()` and `git_remote_download()` now take a pointer |
b1ae3e53 CMN |
309 | to fetch options which determine the runtime configuration. |
310 | ||
311 | * The `git_remote_autotag_option_t` values have been changed. It has | |
c2418f46 | 312 | gained a `_UNSPECIFIED` default value to specify no override for the |
b1ae3e53 CMN |
313 | configured setting. |
314 | ||
315 | * `git_remote_update_tips()` now takes a pointer to the callbacks as | |
316 | well as a boolean whether to write `FETCH_HEAD` and the autotag | |
317 | setting. | |
318 | ||
ae5b9362 CMN |
319 | * `git_remote_create_anonymous()` no longer takes a fetch refspec as |
320 | url-only remotes cannot have configured refspecs. | |
321 | ||
b1ae3e53 CMN |
322 | * The `git_submodule_update_options` struct now has fetch options in |
323 | the `fetch_opts` field instead of callbacks in the | |
324 | `remote_callbacks` field. | |
325 | ||
ca2466ff CMN |
326 | * The following functions no longer act on a submodule instance but |
327 | change the repository's configuration. Their signatures have changed | |
328 | accordingly: | |
329 | ||
330 | * `git_submodule_set_url()`, `git_submodule_set_ignore()`, | |
331 | `git_submodule_set_update()`, | |
332 | `git_submodule_set_fetch_recurse_submodules()`. | |
333 | ||
334 | * `git_submodule_status()` no longer takes a submodule instance but a | |
335 | repsitory, a submodule name and an ignore setting. | |
336 | ||
b1ae3e53 CMN |
337 | * The `push` function in the `git_transport` interface now takes a |
338 | pointer to the remote callbacks. | |
339 | ||
98270f56 CMN |
340 | * The `git_index_entry` struct's fields' types have been changed to |
341 | more accurately reflect what is in fact stored in the | |
342 | index. Specifically, time and file size are 32 bits intead of 64, as | |
343 | these values are truncated. | |
344 | ||
885b94aa ET |
345 | * `GIT_EMERGECONFLICT` is now `GIT_ECONFLICT`, which more accurately |
346 | describes the nature of the error. | |
347 | ||
3cf91d98 CMN |
348 | * It is no longer allowed to call `git_buf_grow()` on buffers |
349 | borrowing the memory they point to. | |
350 | ||
c8b64f70 | 351 | v0.22 |
d30447cb CMN |
352 | ------ |
353 | ||
b91f28be | 354 | ### Changes or improvements |
e1fc03c9 | 355 | |
b91f28be | 356 | * `git_signature_new()` now requires a non-empty email address. |
274c3fa6 | 357 | |
b91f28be | 358 | * Use CommonCrypto libraries for SHA-1 calculation on Mac OS X. |
d412165f | 359 | |
b91f28be CMN |
360 | * Disable SSL compression and SSLv2 and SSLv3 ciphers in favor of TLSv1 |
361 | in OpenSSL. | |
d412165f | 362 | |
b91f28be CMN |
363 | * The fetch behavior of remotes with autotag set to `GIT_REMOTE_DOWNLOAD_TAGS_ALL` |
364 | has been changed to match git 1.9.0 and later. In this mode, libgit2 now | |
365 | fetches all tags in addition to whatever else needs to be fetched. | |
c180c065 | 366 | |
b91f28be CMN |
367 | * `git_checkout()` now handles case-changing renames correctly on |
368 | case-insensitive filesystems; for example renaming "readme" to "README". | |
7449c82e | 369 | |
b91f28be CMN |
370 | * The search for libssh2 is now done via pkg-config instead of a |
371 | custom search of a few directories. | |
3753110a | 372 | |
b91f28be CMN |
373 | * Add support for core.protectHFS and core.protectNTFS. Add more |
374 | validation for filenames which we write such as references. | |
5192bcc5 | 375 | |
b91f28be CMN |
376 | * The local transport now generates textual progress output like |
377 | git-upload-pack does ("counting objects"). | |
c180c065 | 378 | |
b91f28be CMN |
379 | * `git_checkout_index()` can now check out an in-memory index that is not |
380 | necessarily the repository's index, so you may check out an index | |
381 | that was produced by git_merge and friends while retaining the cached | |
382 | information. | |
1697cd6f | 383 | |
b91f28be CMN |
384 | * Remove the default timeout for receiving / sending data over HTTP using |
385 | the WinHTTP transport layer. | |
d4256ed5 | 386 | |
b91f28be | 387 | * Add SPNEGO (Kerberos) authentication using GSSAPI on Unix systems. |
46c8f7f8 | 388 | |
b91f28be CMN |
389 | * Provide built-in objects for the empty blob (e69de29) and empty |
390 | tree (4b825dc) objects. | |
262eec23 | 391 | |
b91f28be CMN |
392 | * The index' tree cache is now filled upon read-tree and write-tree |
393 | and the cache is written to disk. | |
0862f617 | 394 | |
b91f28be | 395 | * LF -> CRLF filter refuses to handle mixed-EOL files |
1697cd6f | 396 | |
b91f28be | 397 | * LF -> CRLF filter now runs when * text = auto (with Git for Windows 1.9.4) |
1697cd6f | 398 | |
b91f28be CMN |
399 | * File unlocks are atomic again via rename. Read-only files on Windows are |
400 | made read-write if necessary. | |
d58a64e9 | 401 | |
b91f28be | 402 | * Share open packfiles across repositories to share descriptors and mmaps. |
6812afaf | 403 | |
b91f28be | 404 | * Use a map for the treebuilder, making insertion O(1) |
2cd3cb8e | 405 | |
b91f28be CMN |
406 | * The build system now accepts an option EMBED_SSH_PATH which when set |
407 | tells it to include a copy of libssh2 at the given location. This is | |
408 | enabled for MSVC. | |
9fef46de CMN |
409 | |
410 | * Add support for refspecs with the asterisk in the middle of a | |
411 | pattern. | |
7db0e6ee | 412 | |
c5837cad CMN |
413 | * Fetching now performs opportunistic updates. To achieve this, we |
414 | introduce a difference between active and passive refspecs, which | |
b91f28be | 415 | make `git_remote_download()` and `git_remote_fetch()` to take a list of |
c5837cad CMN |
416 | resfpecs to be the active list, similarly to how git fetch accepts a |
417 | list on the command-line. | |
418 | ||
b91f28be CMN |
419 | * The THREADSAFE option to build libgit2 with threading support has |
420 | been flipped to be on by default. | |
209425ce | 421 | |
b91f28be CMN |
422 | * The remote object has learnt to prune remote-tracking branches. If |
423 | the remote is configured to do so, this will happen via | |
424 | `git_remote_fetch()`. You can also call `git_remote_prune()` after | |
425 | connecting or fetching to perform the prune. | |
426 | ||
427 | ||
428 | ### API additions | |
d524b2d3 | 429 | |
b91f28be CMN |
430 | * Introduce `git_buf_text_is_binary()` and `git_buf_text_contains_nul()` for |
431 | consumers to perform binary detection on a git_buf. | |
432 | ||
433 | * `git_branch_upstream_remote()` has been introduced to provide the | |
434 | branch.<name>.remote configuration value. | |
435 | ||
436 | * Introduce `git_describe_commit()` and `git_describe_workdir()` to provide | |
437 | a description of the current commit (and working tree, respectively) | |
438 | based on the nearest tag or reference | |
439 | ||
440 | * Introduce `git_merge_bases()` and the `git_oidarray` type to expose all | |
7db0e6ee | 441 | merge bases between two commits. |
eca07bcd | 442 | |
b91f28be | 443 | * Introduce `git_merge_bases_many()` to expose all merge bases between |
eca07bcd | 444 | multiple commits. |
67917281 | 445 | |
67917281 | 446 | * Introduce rebase functionality (using the merge algorithm only). |
b91f28be CMN |
447 | Introduce `git_rebase_init()` to begin a new rebase session, |
448 | `git_rebase_open()` to open an in-progress rebase session, | |
449 | `git_rebase_commit()` to commit the current rebase operation, | |
450 | `git_rebase_next()` to apply the next rebase operation, | |
451 | `git_rebase_abort()` to abort an in-progress rebase and `git_rebase_finish()` | |
67917281 ET |
452 | to complete a rebase operation. |
453 | ||
b91f28be CMN |
454 | * Introduce `git_note_author()` and `git_note_committer()` to get the author |
455 | and committer information on a `git_note`, respectively. | |
79b0ae4e | 456 | |
b91f28be CMN |
457 | * A factory function for ssh has been added which allows to change the |
458 | path of the programs to execute for receive-pack and upload-pack on | |
459 | the server, `git_transport_ssh_with_paths()`. | |
21083a71 | 460 | |
b91f28be CMN |
461 | * The ssh transport supports asking the remote host for accepted |
462 | credential types as well as multiple challeges using a single | |
463 | connection. This requires to know which username you want to connect | |
464 | as, so this introduces the USERNAME credential type which the ssh | |
465 | transport will use to ask for the username. | |
d88766c4 | 466 | |
b91f28be CMN |
467 | * The `GIT_EPEEL` error code has been introduced when we cannot peel a tag |
468 | to the requested object type; if the given object otherwise cannot be | |
469 | peeled, `GIT_EINVALIDSPEC` is returned. | |
68182085 | 470 | |
b91f28be CMN |
471 | * Introduce `GIT_REPOSITORY_INIT_RELATIVE_GITLINK` to use relative paths |
472 | when writing gitlinks, as is used by git core for submodules. | |
e284c451 | 473 | |
b91f28be | 474 | * `git_remote_prune()` has been added. See above for description. |
799e22ea | 475 | |
8aba3d47 | 476 | |
b91f28be CMN |
477 | * Introduce reference transactions, which allow multiple references to |
478 | be locked at the same time and updates be queued. This also allows | |
479 | us to safely update a reflog with arbitrary contents, as we need to | |
480 | do for stash. | |
6d91dc53 | 481 | |
b91f28be | 482 | ### API removals |
dce7b1a4 | 483 | |
b91f28be CMN |
484 | * `git_remote_supported_url()` and `git_remote_is_valid_url()` have been |
485 | removed as they have become essentially useless with rsync-style ssh paths. | |
486 | ||
487 | * `git_clone_into()` and `git_clone_local_into()` have been removed from the | |
488 | public API in favour of `git_clone callbacks`. | |
489 | ||
490 | * The option to ignore certificate errors via `git_remote_cert_check()` | |
491 | is no longer present. Instead, `git_remote_callbacks` has gained a new | |
492 | entry which lets the user perform their own certificate checks. | |
493 | ||
494 | ### Breaking API changes | |
208a2c8a | 495 | |
b91f28be CMN |
496 | * `git_cherry_pick()` is now `git_cherrypick()`. |
497 | ||
498 | * The `git_submodule_update()` function was renamed to | |
499 | `git_submodule_update_strategy()`. `git_submodule_update()` is now used to | |
500 | provide functionalty similar to "git submodule update". | |
501 | ||
502 | * `git_treebuilder_create()` was renamed to `git_treebuilder_new()` to better | |
208a2c8a CMN |
503 | reflect it being a constructor rather than something which writes to |
504 | disk. | |
40d79154 | 505 | |
b91f28be CMN |
506 | * `git_treebuilder_new()` (was `git_treebuilder_create()`) now takes a |
507 | repository so that it can query repository configuration. | |
508 | Subsequently, `git_treebuilder_write()` no longer takes a repository. | |
aad27e6e | 509 | |
b91f28be CMN |
510 | * `git_threads_init()` and `git_threads_shutdown()` have been renamed to |
511 | `git_libgit2_init()` and `git_libgit2_shutdown()` to better explain what | |
512 | their purpose is, as it's grown to be more than just about threads. | |
aad27e6e | 513 | |
b91f28be CMN |
514 | * `git_libgit2_init()` and `git_libgit2_shutdown()` now return the number of |
515 | initializations of the library, so consumers may schedule work on the | |
516 | first initialization. | |
aad27e6e | 517 | |
b91f28be CMN |
518 | * The `git_transport_register()` function no longer takes a priority and takes |
519 | a URL scheme name (eg "http") instead of a prefix like "http://" | |
aad27e6e | 520 | |
b91f28be CMN |
521 | * `git_index_name_entrycount()` and `git_index_reuc_entrycount()` now |
522 | return size_t instead of unsigned int. | |
9d1f97df | 523 | |
b91f28be CMN |
524 | * The `context_lines` and `interhunk_lines` fields in `git_diff`_options are |
525 | now `uint32_t` instead of `uint16_t`. This allows to set them to `UINT_MAX`, | |
526 | in effect asking for "infinite" context e.g. to iterate over all the | |
527 | unmodified lines of a diff. | |
974d21c8 | 528 | |
b91f28be CMN |
529 | * `git_status_file()` now takes an exact path. Use `git_status_list_new()` if |
530 | pathspec searching is needed. | |
974d21c8 | 531 | |
b91f28be CMN |
532 | * `git_note_create()` has changed the position of the notes reference |
533 | name to match `git_note_remove()`. | |
974d21c8 | 534 | |
b91f28be CMN |
535 | * Rename `git_remote_load()` to `git_remote_lookup()` to bring it in line |
536 | with the rest of the lookup functions. | |
974d21c8 | 537 | |
b91f28be CMN |
538 | * `git_remote_rename()` now takes the repository and the remote's |
539 | current name. Accepting a remote indicates we want to change it, | |
540 | which we only did partially. It is much clearer if we accept a name | |
541 | and no loaded objects are changed. | |
974d21c8 | 542 | |
b91f28be CMN |
543 | * `git_remote_delete()` now accepts the repository and the remote's name |
544 | instead of a loaded remote. | |
974d21c8 | 545 | |
b91f28be CMN |
546 | * `git_merge_head` is now `git_annotated_commit`, to better reflect its usage |
547 | for multiple functions (including rebase) | |
974d21c8 | 548 | |
b91f28be CMN |
549 | * The `git_clone_options` struct no longer provides the `ignore_cert_errors` or |
550 | `remote_name` members for remote customization. | |
974d21c8 | 551 | |
b91f28be CMN |
552 | Instead, the `git_clone_options` struct has two new members, `remote_cb` and |
553 | `remote_cb_payload`, which allow the caller to completely override the remote | |
554 | creation process. If needed, the caller can use this callback to give their | |
555 | remote a name other than the default (origin) or disable cert checking. | |
974d21c8 | 556 | |
b91f28be CMN |
557 | The `remote_callbacks` member has been preserved for convenience, although it |
558 | is not used when a remote creation callback is supplied. | |
974d21c8 | 559 | |
b91f28be CMN |
560 | * The `git_clone`_options struct now provides `repository_cb` and |
561 | `repository_cb_payload` to allow the user to create a repository with | |
562 | custom options. | |
974d21c8 | 563 | |
b91f28be CMN |
564 | * The `git_push` struct to perform a push has been replaced with |
565 | `git_remote_upload()`. The refspecs and options are passed as a | |
566 | function argument. `git_push_update_tips()` is now also | |
567 | `git_remote_update_tips()` and the callbacks are in the same struct as | |
568 | the rest. | |
974d21c8 | 569 | |
b91f28be CMN |
570 | * The `git_remote_set_transport()` function now sets a transport factory function, |
571 | rather than a pre-existing transport instance. | |
61cd037e | 572 | |
b91f28be CMN |
573 | * The `git_transport` structure definition has moved into the sys/transport.h |
574 | file. | |
575 | ||
576 | * libgit2 no longer automatically sets the OpenSSL locking | |
577 | functions. This is not something which we can know to do. A | |
578 | last-resort convenience function is provided in sys/openssl.h, | |
579 | `git_openssl_set_locking()` which can be used to set the locking. |