4 ### Changes or improvements
10 ### Breaking API changes
15 ### Changes or improvements
17 * Fix repository discovery with `git_repository_discover` and
18 `git_repository_open_ext` to match git's handling of a ceiling
19 directory at the current directory. git only checks ceiling
20 directories when its search ascends to a parent directory. A ceiling
21 directory matching the starting directory will not prevent git from
22 finding a repository in the starting directory or a parent directory.
24 * Do not fail when deleting remotes in the presence of broken
25 global configs which contain branches.
27 * Support for reading and writing git index v4 files
29 * Improve the performance of the revwalk and bring us closer to git's code.
31 * The reference db has improved support for concurrency and returns `GIT_ELOCKED`
32 when an operation could not be performed due to locking.
34 * Nanosecond resolution is now activated by default, following git's change to
37 * We now restrict the set of ciphers we let OpenSSL use by default.
39 * Users can now register their own merge drivers for use with `.gitattributes`.
40 The library also gained built-in support for the union merge driver.
42 * The default for creating references is now to validate that the object does
45 * Add `git_proxy_options` which is used by the different networking
46 implementations to let the caller specify the proxy settings instead of
47 relying on the environment variables.
51 * You can now get the user-agent used by libgit2 using the
52 `GIT_OPT_GET_USER_AGENT` option with `git_libgit2_opts()`.
53 It is the counterpart to `GIT_OPT_SET_USER_AGENT`.
55 * The `GIT_OPT_SET_SSL_CIPHERS` option for `git_libgit2_opts()` lets you specify
56 a custom list of ciphers to use for OpenSSL.
58 * `git_commit_create_buffer()` creates a commit and writes it into a
59 user-provided buffer instead of writing it into the object db. Combine it with
60 `git_commit_create_with_signature()` in order to create a commit with a
61 cryptographic signature.
63 * `git_blob_create_fromstream()` and
64 `git_blob_create_fromstream_commit()` allow you to create a blob by
65 writing into a stream. Useful when you do not know the final size or
66 want to copy the contents from another stream.
68 * New flags for `git_repository_open_ext`:
70 * `GIT_REPOSITORY_OPEN_NO_DOTGIT` - Do not check for a repository by
71 appending `/.git` to the `start_path`; only open the repository if
72 `start_path` itself points to the git directory.
73 * `GIT_REPOSITORY_OPEN_FROM_ENV` - Find and open a git repository,
74 respecting the environment variables used by the git command-line
75 tools. If set, `git_repository_open_ext` will ignore the other
76 flags and the `ceiling_dirs` argument, and will allow a NULL
77 `path` to use `GIT_DIR` or search from the current directory. The
78 search for a repository will respect `$GIT_CEILING_DIRECTORIES`
79 and `$GIT_DISCOVERY_ACROSS_FILESYSTEM`. The opened repository
80 will respect `$GIT_INDEX_FILE`, `$GIT_NAMESPACE`,
81 `$GIT_OBJECT_DIRECTORY`, and `$GIT_ALTERNATE_OBJECT_DIRECTORIES`.
82 In the future, this flag will also cause `git_repository_open_ext`
83 to respect `$GIT_WORK_TREE` and `$GIT_COMMON_DIR`; currently,
84 `git_repository_open_ext` with this flag will error out if either
85 `$GIT_WORK_TREE` or `$GIT_COMMON_DIR` is set.
87 * `git_diff_from_buffer()` can create a `git_diff` object from the contents
88 of a git-style patch file.
90 * `git_index_version()` and `git_index_set_version()` to get and set
93 * `git_odb_expand_ids()` lets you check for the existence of multiple
96 * The new `git_blob_dup()`, `git_commit_dup()`, `git_tag_dup()` and
97 `git_tree_dup()` functions provide type-specific wrappers for
98 `git_object_dup()` to reduce noise and increase type safety for callers.
100 * `git_reference_dup()` lets you duplicate a reference to aid in ownership
101 management and cleanup.
103 * `git_signature_from_buffer()` lets you create a signature from a string in the
104 format that appear in objects.
106 * `git_tree_create_updated()` lets you create a tree based on another one
107 together with a list of updates. For the covered update cases, it's more
108 efficient than the `git_index` route.
110 * `git_apply_patch()` applies hunks from a `git_patch` to a buffer.
112 * `git_diff_to_buf()` lets you print an entire diff directory to a buffer,
113 similar to how `git_patch_to_buf()` works.
115 * `git_proxy_init_options()` is added to initialize a `git_proxy_options`
116 structure at run-time.
118 * `git_merge_driver_register()`, `git_merge_driver_unregister()` let you
119 register and unregister a custom merge driver to be used when `.gitattributes`
122 * `git_merge_driver_lookup()` can be used to look up a merge driver by name.
124 * `git_merge_driver_source_repo()`, `git_merge_driver_source_ancestor()`,
125 `git_merge_driver_source_ours()`, `git_merge_driver_source_theirs()`,
126 `git_merge_driver_source_file_options()` added as accessors to
127 `git_merge_driver_source`.
131 * `git_blob_create_fromchunks()` has been removed in favour of
132 `git_blob_create_fromstream()`.
134 ### Breaking API changes
136 * `git_packbuilder_object_count` and `git_packbuilder_written` now
137 return a `size_t` instead of a `uint32_t` for more thorough
138 compatibility with the rest of the library.
140 * `git_packbuiler_progress` now provides explicitly sized `uint32_t`
141 values instead of `unsigned int`.
143 * `git_diff_file` now includes an `id_abbrev` field that reflects the
144 number of nibbles set in the `id` field.
146 * `git_odb_backend` now has a `freshen` function pointer. This optional
147 function pointer is similar to the `exists` function, but it will update
148 a last-used marker. For filesystem-based object databases, this updates
149 the timestamp of the file containing the object, to indicate "freshness".
150 If this is `NULL`, then it will not be called and the `exists` function
151 will be used instead.
153 * `git_remote_connect()` now accepts `git_proxy_options` argument, and
154 `git_fetch_options` and `git_push_options` each have a `proxy_opts` field.
156 * `git_merge_options` now provides a `default_driver` that can be used
157 to provide the name of a merge driver to be used to handle files changed
163 ### Changes or improvements
165 * Custom merge drivers can now be registered, which allows callers to
166 configure callbacks to honor `merge=driver` configuration in
169 * Custom filters can now be registered with wildcard attributes, for
170 example `filter=*`. Consumers should examine the attributes parameter
171 of the `check` function for details.
173 * Symlinks are now followed when locking a file, which can be
174 necessary when multiple worktrees share a base repository.
176 * You can now set your own user-agent to be sent for HTTP requests by
177 using the `GIT_OPT_SET_USER_AGENT` with `git_libgit2_opts()`.
179 * You can set custom HTTP header fields to be sent along with requests
180 by passing them in the fetch and push options.
182 * Tree objects are now assumed to be sorted. If a tree is not
183 correctly formed, it will give bad results. This is the git approach
184 and cuts a significant amount of time when reading the trees.
186 * Filter registration is now protected against concurrent
189 * Filenames which are not valid on Windows in an index no longer cause
190 to fail to parse it on that OS.
192 * Rebases can now be performed purely in-memory, without touching the
193 repository's workdir.
195 * When adding objects to the index, or when creating new tree or commit
196 objects, the inputs are validated to ensure that the dependent objects
197 exist and are of the correct type. This object validation can be
198 disabled with the GIT_OPT_ENABLE_STRICT_OBJECT_CREATION option.
200 * The WinHTTP transport's handling of bad credentials now behaves like
201 the others, asking for credentials again.
205 * `git_config_lock()` has been added, which allow for
206 transactional/atomic complex updates to the configuration, removing
207 the opportunity for concurrent operations and not committing any
208 changes until the unlock.
210 * `git_diff_options` added a new callback `progress_cb` to report on the
211 progress of the diff as files are being compared. The documentation of
212 the existing callback `notify_cb` was updated to reflect that it only
213 gets called when new deltas are added to the diff.
215 * `git_fetch_options` and `git_push_options` have gained a `custom_headers`
216 field to set the extra HTTP header fields to send.
218 * `git_stream_register_tls()` lets you register a callback to be used
219 as the constructor for a TLS stream instead of the libgit2 built-in
222 * `git_commit_header_field()` allows you to look up a specific header
225 * `git_commit_extract_signature()` extracts the signature from a
226 commit and gives you both the signature and the signed data so you
231 * No APIs were removed in this version.
233 ### Breaking API changes
235 * The `git_merge_tree_flag_t` is now `git_merge_flag_t`. Subsequently,
236 its members are no longer prefixed with `GIT_MERGE_TREE_FLAG` but are
237 now prefixed with `GIT_MERGE_FLAG`, and the `tree_flags` field of the
238 `git_merge_options` structure is now named `flags`.
240 * The `git_merge_file_flags_t` enum is now `git_merge_file_flag_t` for
241 consistency with other enum type names.
243 * `git_cert` descendent types now have a proper `parent` member
245 * It is the responsibility of the refdb backend to decide what to do
246 with the reflog on ref deletion. The file-based backend must delete
247 it, a database-backed one may wish to archive it.
249 * `git_config_backend` has gained two entries. `lock` and `unlock`
250 with which to implement the transactional/atomic semantics for the
251 configuration backend.
253 * `git_index_add` and `git_index_conflict_add()` will now use the case
254 as provided by the caller on case insensitive systems. Previous
255 versions would keep the case as it existed in the index. This does
256 not affect the higher-level `git_index_add_bypath` or
257 `git_index_add_frombuffer` functions.
259 * The `notify_payload` field of `git_diff_options` was renamed to `payload`
260 to reflect that it's also the payload for the new progress callback.
262 * The `git_config_level_t` enum has gained a higher-priority value
263 `GIT_CONFIG_LEVEL_PROGRAMDATA` which represent a rough Windows equivalent
264 to the system level configuration.
266 * `git_rebase_options` now has a `merge_options` field.
268 * The index no longer performs locking itself. This is not something
269 users of the library should have been relying on as it's not part of
270 the concurrency guarantees.
272 * `git_remote_connect()` now takes a `custom_headers` argument to set
273 the extra HTTP header fields to send.
278 ### Changes or improvements
280 * Patience and minimal diff drivers can now be used for merges.
282 * Merges can now ignore whitespace changes.
284 * Updated binary identification in CRLF filtering to avoid false positives in
287 * Rename and copy detection is enabled for small files.
289 * Checkout can now handle an initial checkout of a repository, making
290 `GIT_CHECKOUT_SAFE_CREATE` unnecessary for users of clone.
292 * The signature parameter in the ref-modifying functions has been
293 removed. Use `git_repository_set_ident()` and
294 `git_repository_ident()` to override the signature to be used.
296 * The local transport now auto-scales the number of threads to use
297 when creating the packfile instead of sticking to one.
299 * Reference renaming now uses the right id for the old value.
301 * The annotated version of branch creation, HEAD detaching and reset
302 allow for specifying the expression from the user to be put into the
305 * `git_rebase_commit` now returns `GIT_EUNMERGED` when you attempt to
306 commit with unstaged changes.
308 * On Mac OS X, we now use SecureTransport to provide the cryptographic
309 support for HTTPS connections insead of OpenSSL.
311 * Checkout can now accept an index for the baseline computations via the
312 `baseline_index` member.
314 * The configuration for fetching is no longer stored inside the
315 `git_remote` struct but has been moved to a `git_fetch_options`. The
316 remote functions now take these options or the callbacks instead of
317 setting them beforehand.
319 * `git_submodule` instances are no longer cached or shared across
320 lookup. Each submodule represents the configuration at the time of
323 * The index now uses diffs for `add_all()` and `update_all()` which
324 gives it a speed boost and closer semantics to git.
326 * The ssh transport now reports the stderr output from the server as
327 the error message, which allows you to get the "repository not
330 * `git_index_conflict_add()` will remove staged entries that exist for
333 * The flags for a `git_diff_file` will now have the `GIT_DIFF_FLAG_EXISTS`
334 bit set when a file exists on that side of the diff. This is useful
335 for understanding whether a side of the diff exists in the presence of
338 * The constructor for a write-stream into the odb now takes
339 `git_off_t` instead of `size_t` for the size of the blob, which
340 allows putting large files into the odb on 32-bit systems.
342 * The remote's push and pull URLs now honor the url.$URL.insteadOf
343 configuration. This allows modifying URL prefixes to a custom
346 * `git_diff_foreach`, `git_diff_blobs`, `git_diff_blob_to_buffer`,
347 and `git_diff_buffers` now accept a new binary callback of type
348 `git_diff_binary_cb` that includes the binary diff information.
350 * The race condition mitigations described in `racy-git.txt` have been
353 * If libcurl is installed, we will use it to connect to HTTP(S)
358 * The `git_merge_options` gained a `file_flags` member.
360 * Parsing and retrieving a configuration value as a path is exposed
361 via `git_config_parse_path()` and `git_config_get_path()`
364 * `git_repository_set_ident()` and `git_repository_ident()` serve to
365 set and query which identity will be used when writing to the
368 * `git_config_entry_free()` frees a config entry.
370 * `git_config_get_string_buf()` provides a way to safely retrieve a
371 string from a non-snapshot configuration.
373 * `git_annotated_commit_from_revspec()` allows to get an annotated
374 commit from an extended sha synatx string.
376 * `git_repository_set_head_detached_from_annotated()`,
377 `git_branch_create_from_annotated()` and
378 `git_reset_from_annotated()` allow for the caller to provide an
379 annotated commit through which they can control what expression is
380 put into the reflog as the source/target.
382 * `git_index_add_frombuffer()` can now create a blob from memory
383 buffer and add it to the index which is attached to a repository.
385 * The structure `git_fetch_options` has been added to determine the
386 runtime configuration for fetching, such as callbacks, pruning and
387 autotag behaviour. It has the runtime initializer
388 `git_fetch_init_options()`.
390 * The enum `git_fetch_prune_t` has been added, letting you specify the
391 pruning behaviour for a fetch.
393 * A push operation will notify the caller of what updates it indends
394 to perform on the remote, which provides similar information to
397 * `git_stash_apply()` can now apply a stashed state from the stash list,
398 placing the data into the working directory and index.
400 * `git_stash_pop()` will apply a stashed state (like `git_stash_apply()`)
401 but will remove the stashed state after a successful application.
403 * A new error code `GIT_EEOF` indicates an early EOF from the
404 server. This typically indicates an error with the URL or
405 configuration of the server, and tools can use this to show messages
406 about failing to communicate with the server.
408 * A new error code `GIT_EINVALID` indicates that an argument to a
409 function is invalid, or an invalid operation was requested.
411 * `git_diff_index_to_workdir()` and `git_diff_tree_to_index()` will now
412 produce deltas of type `GIT_DELTA_CONFLICTED` to indicate that the index
413 side of the delta is a conflict.
415 * The `git_status` family of functions will now produce status of type
416 `GIT_STATUS_CONFLICTED` to indicate that a conflict exists for that file
419 * `git_index_entry_is_conflict()` is a utility function to determine if
420 a given index entry has a non-zero stage entry, indicating that it is
421 one side of a conflict.
423 * It is now possible to pass a keypair via a buffer instead of a
424 path. For this, `GIT_CREDTYPE_SSH_MEMORY` and
425 `git_cred_ssh_key_memory_new()` have been added.
427 * `git_filter_list_contains` will indicate whether a particular
428 filter will be run in the given filter list.
430 * `git_commit_header_field()` has been added, which allows retrieving
431 the contents of an arbitrary header field.
433 * `git_submodule_set_branch()` allows to set the configured branch for
438 * `git_remote_save()` and `git_remote_clear_refspecs()` have been
439 removed. Remote's configuration is changed via the configuration
440 directly or through a convenience function which performs changes to
441 the configuration directly.
443 * `git_remote_set_callbacks()`, `git_remote_get_callbacks()` and
444 `git_remote_set_transport()` have been removed and the remote no
445 longer stores this configuration.
447 * `git_remote_set_fetch_refpecs()` and
448 `git_remote_set_push_refspecs()` have been removed. There is no
449 longer a way to set the base refspecs at run-time.
451 * `git_submodule_save()` has been removed. The submodules are no
452 longer configured via the objects.
454 * `git_submodule_reload_all()` has been removed as we no longer cache
457 ### Breaking API changes
459 * `git_smart_subtransport_cb` now has a `param` parameter.
461 * The `git_merge_options` structure member `flags` has been renamed
464 * The `git_merge_file_options` structure member `flags` is now
465 an unsigned int. It was previously a `git_merge_file_flags_t`.
467 * `GIT_CHECKOUT_SAFE_CREATE` has been removed. Most users will generally
468 be able to switch to `GIT_CHECKOUT_SAFE`, but if you require missing
469 file handling during checkout, you may now use `GIT_CHECKOUT_SAFE |
470 GIT_CHECKOUT_RECREATE_MISSING`.
472 * The `git_clone_options` and `git_submodule_update_options`
473 structures no longer have a `signature` field.
475 * The following functions have removed the signature and/or log message
476 parameters in favour of git-emulating ones.
478 * `git_branch_create()`, `git_branch_move()`
479 * `git_rebase_init()`, `git_rebase_abort()`
480 * `git_reference_symbolic_create_matching()`,
481 `git_reference_symbolic_create()`, `git_reference_create()`,
482 `git_reference_create_matching()`,
483 `git_reference_symbolic_set_target()`,
484 `git_reference_set_target()`, `git_reference_rename()`
485 * `git_remote_update_tips()`, `git_remote_fetch()`, `git_remote_push()`
486 * `git_repository_set_head()`,
487 `git_repository_set_head_detached()`,
488 `git_repository_detach_head()`
491 * `git_config_get_entry()` now gives back a ref-counted
492 `git_config_entry`. You must free it when you no longer need it.
494 * `git_config_get_string()` will return an error if used on a
495 non-snapshot configuration, as there can be no guarantee that the
496 returned pointer is valid.
498 * `git_note_default_ref()` now uses a `git_buf` to return the string,
499 as the string is otherwise not guaranteed to stay allocated.
501 * `git_rebase_operation_current()` will return `GIT_REBASE_NO_OPERATION`
502 if it is called immediately after creating a rebase session but before
503 you have applied the first patch.
505 * `git_rebase_options` now contains a `git_checkout_options` struct
506 that will be used for functions that modify the working directory,
507 namely `git_rebase_init`, `git_rebase_next` and
508 `git_rebase_abort`. As a result, `git_rebase_open` now also takes
509 a `git_rebase_options` and only the `git_rebase_init` and
510 `git_rebase_open` functions take a `git_rebase_options`, where they
511 will persist the options to subsequent `git_rebase` calls.
513 * The `git_clone_options` struct now has fetch options in a
514 `fetch_opts` field instead of remote callbacks in
517 * The remote callbacks has gained a new member `push_negotiation`
518 which gets called before sending the update commands to the server.
520 * The following functions no longer act on a remote instance but
521 change the repository's configuration. Their signatures have changed
524 * `git_remote_set_url()`, `git_remote_seturl()`
525 * `git_remote_add_fetch()`, `git_remote_add_push()` and
526 * `git_remote_set_autotag()`
528 * `git_remote_connect()` and `git_remote_prune()` now take a pointer
531 * `git_remote_fetch()` and `git_remote_download()` now take a pointer
532 to fetch options which determine the runtime configuration.
534 * The `git_remote_autotag_option_t` values have been changed. It has
535 gained a `_UNSPECIFIED` default value to specify no override for the
538 * `git_remote_update_tips()` now takes a pointer to the callbacks as
539 well as a boolean whether to write `FETCH_HEAD` and the autotag
542 * `git_remote_create_anonymous()` no longer takes a fetch refspec as
543 url-only remotes cannot have configured refspecs.
545 * The `git_submodule_update_options` struct now has fetch options in
546 the `fetch_opts` field instead of callbacks in the
547 `remote_callbacks` field.
549 * The following functions no longer act on a submodule instance but
550 change the repository's configuration. Their signatures have changed
553 * `git_submodule_set_url()`, `git_submodule_set_ignore()`,
554 `git_submodule_set_update()`,
555 `git_submodule_set_fetch_recurse_submodules()`.
557 * `git_submodule_status()` no longer takes a submodule instance but a
558 repsitory, a submodule name and an ignore setting.
560 * The `push` function in the `git_transport` interface now takes a
561 pointer to the remote callbacks.
563 * The `git_index_entry` struct's fields' types have been changed to
564 more accurately reflect what is in fact stored in the
565 index. Specifically, time and file size are 32 bits intead of 64, as
566 these values are truncated.
568 * `GIT_EMERGECONFLICT` is now `GIT_ECONFLICT`, which more accurately
569 describes the nature of the error.
571 * It is no longer allowed to call `git_buf_grow()` on buffers
572 borrowing the memory they point to.
577 ### Changes or improvements
579 * `git_signature_new()` now requires a non-empty email address.
581 * Use CommonCrypto libraries for SHA-1 calculation on Mac OS X.
583 * Disable SSL compression and SSLv2 and SSLv3 ciphers in favor of TLSv1
586 * The fetch behavior of remotes with autotag set to `GIT_REMOTE_DOWNLOAD_TAGS_ALL`
587 has been changed to match git 1.9.0 and later. In this mode, libgit2 now
588 fetches all tags in addition to whatever else needs to be fetched.
590 * `git_checkout()` now handles case-changing renames correctly on
591 case-insensitive filesystems; for example renaming "readme" to "README".
593 * The search for libssh2 is now done via pkg-config instead of a
594 custom search of a few directories.
596 * Add support for core.protectHFS and core.protectNTFS. Add more
597 validation for filenames which we write such as references.
599 * The local transport now generates textual progress output like
600 git-upload-pack does ("counting objects").
602 * `git_checkout_index()` can now check out an in-memory index that is not
603 necessarily the repository's index, so you may check out an index
604 that was produced by git_merge and friends while retaining the cached
607 * Remove the default timeout for receiving / sending data over HTTP using
608 the WinHTTP transport layer.
610 * Add SPNEGO (Kerberos) authentication using GSSAPI on Unix systems.
612 * Provide built-in objects for the empty blob (e69de29) and empty
613 tree (4b825dc) objects.
615 * The index' tree cache is now filled upon read-tree and write-tree
616 and the cache is written to disk.
618 * LF -> CRLF filter refuses to handle mixed-EOL files
620 * LF -> CRLF filter now runs when * text = auto (with Git for Windows 1.9.4)
622 * File unlocks are atomic again via rename. Read-only files on Windows are
623 made read-write if necessary.
625 * Share open packfiles across repositories to share descriptors and mmaps.
627 * Use a map for the treebuilder, making insertion O(1)
629 * The build system now accepts an option EMBED_SSH_PATH which when set
630 tells it to include a copy of libssh2 at the given location. This is
633 * Add support for refspecs with the asterisk in the middle of a
636 * Fetching now performs opportunistic updates. To achieve this, we
637 introduce a difference between active and passive refspecs, which
638 make `git_remote_download()` and `git_remote_fetch()` to take a list of
639 resfpecs to be the active list, similarly to how git fetch accepts a
640 list on the command-line.
642 * The THREADSAFE option to build libgit2 with threading support has
643 been flipped to be on by default.
645 * The remote object has learnt to prune remote-tracking branches. If
646 the remote is configured to do so, this will happen via
647 `git_remote_fetch()`. You can also call `git_remote_prune()` after
648 connecting or fetching to perform the prune.
653 * Introduce `git_buf_text_is_binary()` and `git_buf_text_contains_nul()` for
654 consumers to perform binary detection on a git_buf.
656 * `git_branch_upstream_remote()` has been introduced to provide the
657 branch.<name>.remote configuration value.
659 * Introduce `git_describe_commit()` and `git_describe_workdir()` to provide
660 a description of the current commit (and working tree, respectively)
661 based on the nearest tag or reference
663 * Introduce `git_merge_bases()` and the `git_oidarray` type to expose all
664 merge bases between two commits.
666 * Introduce `git_merge_bases_many()` to expose all merge bases between
669 * Introduce rebase functionality (using the merge algorithm only).
670 Introduce `git_rebase_init()` to begin a new rebase session,
671 `git_rebase_open()` to open an in-progress rebase session,
672 `git_rebase_commit()` to commit the current rebase operation,
673 `git_rebase_next()` to apply the next rebase operation,
674 `git_rebase_abort()` to abort an in-progress rebase and `git_rebase_finish()`
675 to complete a rebase operation.
677 * Introduce `git_note_author()` and `git_note_committer()` to get the author
678 and committer information on a `git_note`, respectively.
680 * A factory function for ssh has been added which allows to change the
681 path of the programs to execute for receive-pack and upload-pack on
682 the server, `git_transport_ssh_with_paths()`.
684 * The ssh transport supports asking the remote host for accepted
685 credential types as well as multiple challeges using a single
686 connection. This requires to know which username you want to connect
687 as, so this introduces the USERNAME credential type which the ssh
688 transport will use to ask for the username.
690 * The `GIT_EPEEL` error code has been introduced when we cannot peel a tag
691 to the requested object type; if the given object otherwise cannot be
692 peeled, `GIT_EINVALIDSPEC` is returned.
694 * Introduce `GIT_REPOSITORY_INIT_RELATIVE_GITLINK` to use relative paths
695 when writing gitlinks, as is used by git core for submodules.
697 * `git_remote_prune()` has been added. See above for description.
700 * Introduce reference transactions, which allow multiple references to
701 be locked at the same time and updates be queued. This also allows
702 us to safely update a reflog with arbitrary contents, as we need to
707 * `git_remote_supported_url()` and `git_remote_is_valid_url()` have been
708 removed as they have become essentially useless with rsync-style ssh paths.
710 * `git_clone_into()` and `git_clone_local_into()` have been removed from the
711 public API in favour of `git_clone callbacks`.
713 * The option to ignore certificate errors via `git_remote_cert_check()`
714 is no longer present. Instead, `git_remote_callbacks` has gained a new
715 entry which lets the user perform their own certificate checks.
717 ### Breaking API changes
719 * `git_cherry_pick()` is now `git_cherrypick()`.
721 * The `git_submodule_update()` function was renamed to
722 `git_submodule_update_strategy()`. `git_submodule_update()` is now used to
723 provide functionalty similar to "git submodule update".
725 * `git_treebuilder_create()` was renamed to `git_treebuilder_new()` to better
726 reflect it being a constructor rather than something which writes to
729 * `git_treebuilder_new()` (was `git_treebuilder_create()`) now takes a
730 repository so that it can query repository configuration.
731 Subsequently, `git_treebuilder_write()` no longer takes a repository.
733 * `git_threads_init()` and `git_threads_shutdown()` have been renamed to
734 `git_libgit2_init()` and `git_libgit2_shutdown()` to better explain what
735 their purpose is, as it's grown to be more than just about threads.
737 * `git_libgit2_init()` and `git_libgit2_shutdown()` now return the number of
738 initializations of the library, so consumers may schedule work on the
739 first initialization.
741 * The `git_transport_register()` function no longer takes a priority and takes
742 a URL scheme name (eg "http") instead of a prefix like "http://"
744 * `git_index_name_entrycount()` and `git_index_reuc_entrycount()` now
745 return size_t instead of unsigned int.
747 * The `context_lines` and `interhunk_lines` fields in `git_diff`_options are
748 now `uint32_t` instead of `uint16_t`. This allows to set them to `UINT_MAX`,
749 in effect asking for "infinite" context e.g. to iterate over all the
750 unmodified lines of a diff.
752 * `git_status_file()` now takes an exact path. Use `git_status_list_new()` if
753 pathspec searching is needed.
755 * `git_note_create()` has changed the position of the notes reference
756 name to match `git_note_remove()`.
758 * Rename `git_remote_load()` to `git_remote_lookup()` to bring it in line
759 with the rest of the lookup functions.
761 * `git_remote_rename()` now takes the repository and the remote's
762 current name. Accepting a remote indicates we want to change it,
763 which we only did partially. It is much clearer if we accept a name
764 and no loaded objects are changed.
766 * `git_remote_delete()` now accepts the repository and the remote's name
767 instead of a loaded remote.
769 * `git_merge_head` is now `git_annotated_commit`, to better reflect its usage
770 for multiple functions (including rebase)
772 * The `git_clone_options` struct no longer provides the `ignore_cert_errors` or
773 `remote_name` members for remote customization.
775 Instead, the `git_clone_options` struct has two new members, `remote_cb` and
776 `remote_cb_payload`, which allow the caller to completely override the remote
777 creation process. If needed, the caller can use this callback to give their
778 remote a name other than the default (origin) or disable cert checking.
780 The `remote_callbacks` member has been preserved for convenience, although it
781 is not used when a remote creation callback is supplied.
783 * The `git_clone`_options struct now provides `repository_cb` and
784 `repository_cb_payload` to allow the user to create a repository with
787 * The `git_push` struct to perform a push has been replaced with
788 `git_remote_upload()`. The refspecs and options are passed as a
789 function argument. `git_push_update_tips()` is now also
790 `git_remote_update_tips()` and the callbacks are in the same struct as
793 * The `git_remote_set_transport()` function now sets a transport factory function,
794 rather than a pre-existing transport instance.
796 * The `git_transport` structure definition has moved into the sys/transport.h
799 * libgit2 no longer automatically sets the OpenSSL locking
800 functions. This is not something which we can know to do. A
801 last-resort convenience function is provided in sys/openssl.h,
802 `git_openssl_set_locking()` which can be used to set the locking.