4 ### Changes or improvements
8 * `git_commit_create_buffer()` creates a commit and writes it into a
9 user-provided buffer instead of writing it into the object db.
13 ### Breaking API changes
18 ### Changes or improvements
20 * Custom merge drivers can now be registered, which allows callers to
21 configure callbacks to honor `merge=driver` configuration in
24 * Custom filters can now be registered with wildcard attributes, for
25 example `filter=*`. Consumers should examine the attributes parameter
26 of the `check` function for details.
28 * Symlinks are now followed when locking a file, which can be
29 necessary when multiple worktrees share a base repository.
31 * You can now set your own user-agent to be sent for HTTP requests by
32 using the `GIT_OPT_SET_USER_AGENT` with `git_libgit2_opts()`.
34 * You can set custom HTTP header fields to be sent along with requests
35 by passing them in the fetch and push options.
37 * Tree objects are now assumed to be sorted. If a tree is not
38 correctly formed, it will give bad results. This is the git approach
39 and cuts a significant amount of time when reading the trees.
41 * Filter registration is now protected against concurrent
44 * Filenames which are not valid on Windows in an index no longer cause
45 to fail to parse it on that OS.
47 * Rebases can now be performed purely in-memory, without touching the
50 * When adding objects to the index, or when creating new tree or commit
51 objects, the inputs are validated to ensure that the dependent objects
52 exist and are of the correct type. This object validation can be
53 disabled with the GIT_OPT_ENABLE_STRICT_OBJECT_CREATION option.
55 * The WinHTTP transport's handling of bad credentials now behaves like
56 the others, asking for credentials again.
60 * `git_config_lock()` has been added, which allow for
61 transactional/atomic complex updates to the configuration, removing
62 the opportunity for concurrent operations and not committing any
63 changes until the unlock.
65 * `git_diff_options` added a new callback `progress_cb` to report on the
66 progress of the diff as files are being compared. The documentation of
67 the existing callback `notify_cb` was updated to reflect that it only
68 gets called when new deltas are added to the diff.
70 * `git_fetch_options` and `git_push_options` have gained a `custom_headers`
71 field to set the extra HTTP header fields to send.
73 * `git_stream_register_tls()` lets you register a callback to be used
74 as the constructor for a TLS stream instead of the libgit2 built-in
77 * `git_commit_header_field()` allows you to look up a specific header
80 * `git_commit_extract_signature()` extracts the signature from a
81 commit and gives you both the signature and the signed data so you
86 * No APIs were removed in this version.
88 ### Breaking API changes
90 * `git_merge_options` now provides a `default_driver` that can be used
91 to provide the name of a merge driver to be used to handle files changed
94 * The `git_merge_tree_flag_t` is now `git_merge_flag_t`. Subsequently,
95 its members are no longer prefixed with `GIT_MERGE_TREE_FLAG` but are
96 now prefixed with `GIT_MERGE_FLAG`, and the `tree_flags` field of the
97 `git_merge_options` structure is now named `flags`.
99 * The `git_merge_file_flags_t` enum is now `git_merge_file_flag_t` for
100 consistency with other enum type names.
102 * `git_cert` descendent types now have a proper `parent` member
104 * It is the responsibility of the refdb backend to decide what to do
105 with the reflog on ref deletion. The file-based backend must delete
106 it, a database-backed one may wish to archive it.
108 * `git_config_backend` has gained two entries. `lock` and `unlock`
109 with which to implement the transactional/atomic semantics for the
110 configuration backend.
112 * `git_index_add` and `git_index_conflict_add()` will now use the case
113 as provided by the caller on case insensitive systems. Previous
114 versions would keep the case as it existed in the index. This does
115 not affect the higher-level `git_index_add_bypath` or
116 `git_index_add_frombuffer` functions.
118 * The `notify_payload` field of `git_diff_options` was renamed to `payload`
119 to reflect that it's also the payload for the new progress callback.
121 * The `git_config_level_t` enum has gained a higher-priority value
122 `GIT_CONFIG_LEVEL_PROGRAMDATA` which represent a rough Windows equivalent
123 to the system level configuration.
125 * `git_rebase_init()` not also takes a merge options.
127 * The index no longer performs locking itself. This is not something
128 users of the library should have been relying on as it's not part of
129 the concurrency guarantees.
134 ### Changes or improvements
136 * Patience and minimal diff drivers can now be used for merges.
138 * Merges can now ignore whitespace changes.
140 * Updated binary identification in CRLF filtering to avoid false positives in
143 * Rename and copy detection is enabled for small files.
145 * Checkout can now handle an initial checkout of a repository, making
146 `GIT_CHECKOUT_SAFE_CREATE` unnecessary for users of clone.
148 * The signature parameter in the ref-modifying functions has been
149 removed. Use `git_repository_set_ident()` and
150 `git_repository_ident()` to override the signature to be used.
152 * The local transport now auto-scales the number of threads to use
153 when creating the packfile instead of sticking to one.
155 * Reference renaming now uses the right id for the old value.
157 * The annotated version of branch creation, HEAD detaching and reset
158 allow for specifying the expression from the user to be put into the
161 * `git_rebase_commit` now returns `GIT_EUNMERGED` when you attempt to
162 commit with unstaged changes.
164 * On Mac OS X, we now use SecureTransport to provide the cryptographic
165 support for HTTPS connections insead of OpenSSL.
167 * Checkout can now accept an index for the baseline computations via the
168 `baseline_index` member.
170 * The configuration for fetching is no longer stored inside the
171 `git_remote` struct but has been moved to a `git_fetch_options`. The
172 remote functions now take these options or the callbacks instead of
173 setting them beforehand.
175 * `git_submodule` instances are no longer cached or shared across
176 lookup. Each submodule represents the configuration at the time of
179 * The index now uses diffs for `add_all()` and `update_all()` which
180 gives it a speed boost and closer semantics to git.
182 * The ssh transport now reports the stderr output from the server as
183 the error message, which allows you to get the "repository not
186 * `git_index_conflict_add()` will remove staged entries that exist for
189 * The flags for a `git_diff_file` will now have the `GIT_DIFF_FLAG_EXISTS`
190 bit set when a file exists on that side of the diff. This is useful
191 for understanding whether a side of the diff exists in the presence of
194 * The constructor for a write-stream into the odb now takes
195 `git_off_t` instead of `size_t` for the size of the blob, which
196 allows putting large files into the odb on 32-bit systems.
198 * The remote's push and pull URLs now honor the url.$URL.insteadOf
199 configuration. This allows modifying URL prefixes to a custom
202 * `git_diff_foreach`, `git_diff_blobs`, `git_diff_blob_to_buffer`,
203 and `git_diff_buffers` now accept a new binary callback of type
204 `git_diff_binary_cb` that includes the binary diff information.
206 * The race condition mitigations described in `racy-git.txt` have been
209 * If libcurl is installed, we will use it to connect to HTTP(S)
214 * The `git_merge_options` gained a `file_flags` member.
216 * Parsing and retrieving a configuration value as a path is exposed
217 via `git_config_parse_path()` and `git_config_get_path()`
220 * `git_repository_set_ident()` and `git_repository_ident()` serve to
221 set and query which identity will be used when writing to the
224 * `git_config_entry_free()` frees a config entry.
226 * `git_config_get_string_buf()` provides a way to safely retrieve a
227 string from a non-snapshot configuration.
229 * `git_annotated_commit_from_revspec()` allows to get an annotated
230 commit from an extended sha synatx string.
232 * `git_repository_set_head_detached_from_annotated()`,
233 `git_branch_create_from_annotated()` and
234 `git_reset_from_annotated()` allow for the caller to provide an
235 annotated commit through which they can control what expression is
236 put into the reflog as the source/target.
238 * `git_index_add_frombuffer()` can now create a blob from memory
239 buffer and add it to the index which is attached to a repository.
241 * The structure `git_fetch_options` has been added to determine the
242 runtime configuration for fetching, such as callbacks, pruning and
243 autotag behaviour. It has the runtime initializer
244 `git_fetch_init_options()`.
246 * The enum `git_fetch_prune_t` has been added, letting you specify the
247 pruning behaviour for a fetch.
249 * A push operation will notify the caller of what updates it indends
250 to perform on the remote, which provides similar information to
253 * `git_stash_apply()` can now apply a stashed state from the stash list,
254 placing the data into the working directory and index.
256 * `git_stash_pop()` will apply a stashed state (like `git_stash_apply()`)
257 but will remove the stashed state after a successful application.
259 * A new error code `GIT_EEOF` indicates an early EOF from the
260 server. This typically indicates an error with the URL or
261 configuration of the server, and tools can use this to show messages
262 about failing to communicate with the server.
264 * A new error code `GIT_EINVALID` indicates that an argument to a
265 function is invalid, or an invalid operation was requested.
267 * `git_diff_index_to_workdir()` and `git_diff_tree_to_index()` will now
268 produce deltas of type `GIT_DELTA_CONFLICTED` to indicate that the index
269 side of the delta is a conflict.
271 * The `git_status` family of functions will now produce status of type
272 `GIT_STATUS_CONFLICTED` to indicate that a conflict exists for that file
275 * `git_index_entry_is_conflict()` is a utility function to determine if
276 a given index entry has a non-zero stage entry, indicating that it is
277 one side of a conflict.
279 * It is now possible to pass a keypair via a buffer instead of a
280 path. For this, `GIT_CREDTYPE_SSH_MEMORY` and
281 `git_cred_ssh_key_memory_new()` have been added.
283 * `git_filter_list_contains` will indicate whether a particular
284 filter will be run in the given filter list.
286 * `git_commit_header_field()` has been added, which allows retrieving
287 the contents of an arbitrary header field.
289 * `git_submodule_set_branch()` allows to set the configured branch for
294 * `git_remote_save()` and `git_remote_clear_refspecs()` have been
295 removed. Remote's configuration is changed via the configuration
296 directly or through a convenience function which performs changes to
297 the configuration directly.
299 * `git_remote_set_callbacks()`, `git_remote_get_callbacks()` and
300 `git_remote_set_transport()` have been removed and the remote no
301 longer stores this configuration.
303 * `git_remote_set_fetch_refpecs()` and
304 `git_remote_set_push_refspecs()` have been removed. There is no
305 longer a way to set the base refspecs at run-time.
307 * `git_submodule_save()` has been removed. The submodules are no
308 longer configured via the objects.
310 * `git_submodule_reload_all()` has been removed as we no longer cache
313 ### Breaking API changes
315 * `git_smart_subtransport_cb` now has a `param` parameter.
317 * The `git_merge_options` structure member `flags` has been renamed
320 * The `git_merge_file_options` structure member `flags` is now
321 an unsigned int. It was previously a `git_merge_file_flags_t`.
323 * `GIT_CHECKOUT_SAFE_CREATE` has been removed. Most users will generally
324 be able to switch to `GIT_CHECKOUT_SAFE`, but if you require missing
325 file handling during checkout, you may now use `GIT_CHECKOUT_SAFE |
326 GIT_CHECKOUT_RECREATE_MISSING`.
328 * The `git_clone_options` and `git_submodule_update_options`
329 structures no longer have a `signature` field.
331 * The following functions have removed the signature and/or log message
332 parameters in favour of git-emulating ones.
334 * `git_branch_create()`, `git_branch_move()`
335 * `git_rebase_init()`, `git_rebase_abort()`
336 * `git_reference_symbolic_create_matching()`,
337 `git_reference_symbolic_create()`, `git_reference_create()`,
338 `git_reference_create_matching()`,
339 `git_reference_symbolic_set_target()`,
340 `git_reference_set_target()`, `git_reference_rename()`
341 * `git_remote_update_tips()`, `git_remote_fetch()`, `git_remote_push()`
342 * `git_repository_set_head()`,
343 `git_repository_set_head_detached()`,
344 `git_repository_detach_head()`
347 * `git_config_get_entry()` now gives back a ref-counted
348 `git_config_entry`. You must free it when you no longer need it.
350 * `git_config_get_string()` will return an error if used on a
351 non-snapshot configuration, as there can be no guarantee that the
352 returned pointer is valid.
354 * `git_note_default_ref()` now uses a `git_buf` to return the string,
355 as the string is otherwise not guaranteed to stay allocated.
357 * `git_rebase_operation_current()` will return `GIT_REBASE_NO_OPERATION`
358 if it is called immediately after creating a rebase session but before
359 you have applied the first patch.
361 * `git_rebase_options` now contains a `git_checkout_options` struct
362 that will be used for functions that modify the working directory,
363 namely `git_rebase_init`, `git_rebase_next` and
364 `git_rebase_abort`. As a result, `git_rebase_open` now also takes
365 a `git_rebase_options` and only the `git_rebase_init` and
366 `git_rebase_open` functions take a `git_rebase_options`, where they
367 will persist the options to subsequent `git_rebase` calls.
369 * The `git_clone_options` struct now has fetch options in a
370 `fetch_opts` field instead of remote callbacks in
373 * The remote callbacks has gained a new member `push_negotiation`
374 which gets called before sending the update commands to the server.
376 * The following functions no longer act on a remote instance but
377 change the repository's configuration. Their signatures have changed
380 * `git_remote_set_url()`, `git_remote_seturl()`
381 * `git_remote_add_fetch()`, `git_remote_add_push()` and
382 * `git_remote_set_autotag()`
384 * `git_remote_connect()` and `git_remote_prune()` now take a pointer
387 * `git_remote_fetch()` and `git_remote_download()` now take a pointer
388 to fetch options which determine the runtime configuration.
390 * The `git_remote_autotag_option_t` values have been changed. It has
391 gained a `_UNSPECIFIED` default value to specify no override for the
394 * `git_remote_update_tips()` now takes a pointer to the callbacks as
395 well as a boolean whether to write `FETCH_HEAD` and the autotag
398 * `git_remote_create_anonymous()` no longer takes a fetch refspec as
399 url-only remotes cannot have configured refspecs.
401 * The `git_submodule_update_options` struct now has fetch options in
402 the `fetch_opts` field instead of callbacks in the
403 `remote_callbacks` field.
405 * The following functions no longer act on a submodule instance but
406 change the repository's configuration. Their signatures have changed
409 * `git_submodule_set_url()`, `git_submodule_set_ignore()`,
410 `git_submodule_set_update()`,
411 `git_submodule_set_fetch_recurse_submodules()`.
413 * `git_submodule_status()` no longer takes a submodule instance but a
414 repsitory, a submodule name and an ignore setting.
416 * The `push` function in the `git_transport` interface now takes a
417 pointer to the remote callbacks.
419 * The `git_index_entry` struct's fields' types have been changed to
420 more accurately reflect what is in fact stored in the
421 index. Specifically, time and file size are 32 bits intead of 64, as
422 these values are truncated.
424 * `GIT_EMERGECONFLICT` is now `GIT_ECONFLICT`, which more accurately
425 describes the nature of the error.
427 * It is no longer allowed to call `git_buf_grow()` on buffers
428 borrowing the memory they point to.
433 ### Changes or improvements
435 * `git_signature_new()` now requires a non-empty email address.
437 * Use CommonCrypto libraries for SHA-1 calculation on Mac OS X.
439 * Disable SSL compression and SSLv2 and SSLv3 ciphers in favor of TLSv1
442 * The fetch behavior of remotes with autotag set to `GIT_REMOTE_DOWNLOAD_TAGS_ALL`
443 has been changed to match git 1.9.0 and later. In this mode, libgit2 now
444 fetches all tags in addition to whatever else needs to be fetched.
446 * `git_checkout()` now handles case-changing renames correctly on
447 case-insensitive filesystems; for example renaming "readme" to "README".
449 * The search for libssh2 is now done via pkg-config instead of a
450 custom search of a few directories.
452 * Add support for core.protectHFS and core.protectNTFS. Add more
453 validation for filenames which we write such as references.
455 * The local transport now generates textual progress output like
456 git-upload-pack does ("counting objects").
458 * `git_checkout_index()` can now check out an in-memory index that is not
459 necessarily the repository's index, so you may check out an index
460 that was produced by git_merge and friends while retaining the cached
463 * Remove the default timeout for receiving / sending data over HTTP using
464 the WinHTTP transport layer.
466 * Add SPNEGO (Kerberos) authentication using GSSAPI on Unix systems.
468 * Provide built-in objects for the empty blob (e69de29) and empty
469 tree (4b825dc) objects.
471 * The index' tree cache is now filled upon read-tree and write-tree
472 and the cache is written to disk.
474 * LF -> CRLF filter refuses to handle mixed-EOL files
476 * LF -> CRLF filter now runs when * text = auto (with Git for Windows 1.9.4)
478 * File unlocks are atomic again via rename. Read-only files on Windows are
479 made read-write if necessary.
481 * Share open packfiles across repositories to share descriptors and mmaps.
483 * Use a map for the treebuilder, making insertion O(1)
485 * The build system now accepts an option EMBED_SSH_PATH which when set
486 tells it to include a copy of libssh2 at the given location. This is
489 * Add support for refspecs with the asterisk in the middle of a
492 * Fetching now performs opportunistic updates. To achieve this, we
493 introduce a difference between active and passive refspecs, which
494 make `git_remote_download()` and `git_remote_fetch()` to take a list of
495 resfpecs to be the active list, similarly to how git fetch accepts a
496 list on the command-line.
498 * The THREADSAFE option to build libgit2 with threading support has
499 been flipped to be on by default.
501 * The remote object has learnt to prune remote-tracking branches. If
502 the remote is configured to do so, this will happen via
503 `git_remote_fetch()`. You can also call `git_remote_prune()` after
504 connecting or fetching to perform the prune.
509 * Introduce `git_buf_text_is_binary()` and `git_buf_text_contains_nul()` for
510 consumers to perform binary detection on a git_buf.
512 * `git_branch_upstream_remote()` has been introduced to provide the
513 branch.<name>.remote configuration value.
515 * Introduce `git_describe_commit()` and `git_describe_workdir()` to provide
516 a description of the current commit (and working tree, respectively)
517 based on the nearest tag or reference
519 * Introduce `git_merge_bases()` and the `git_oidarray` type to expose all
520 merge bases between two commits.
522 * Introduce `git_merge_bases_many()` to expose all merge bases between
525 * Introduce rebase functionality (using the merge algorithm only).
526 Introduce `git_rebase_init()` to begin a new rebase session,
527 `git_rebase_open()` to open an in-progress rebase session,
528 `git_rebase_commit()` to commit the current rebase operation,
529 `git_rebase_next()` to apply the next rebase operation,
530 `git_rebase_abort()` to abort an in-progress rebase and `git_rebase_finish()`
531 to complete a rebase operation.
533 * Introduce `git_note_author()` and `git_note_committer()` to get the author
534 and committer information on a `git_note`, respectively.
536 * A factory function for ssh has been added which allows to change the
537 path of the programs to execute for receive-pack and upload-pack on
538 the server, `git_transport_ssh_with_paths()`.
540 * The ssh transport supports asking the remote host for accepted
541 credential types as well as multiple challeges using a single
542 connection. This requires to know which username you want to connect
543 as, so this introduces the USERNAME credential type which the ssh
544 transport will use to ask for the username.
546 * The `GIT_EPEEL` error code has been introduced when we cannot peel a tag
547 to the requested object type; if the given object otherwise cannot be
548 peeled, `GIT_EINVALIDSPEC` is returned.
550 * Introduce `GIT_REPOSITORY_INIT_RELATIVE_GITLINK` to use relative paths
551 when writing gitlinks, as is used by git core for submodules.
553 * `git_remote_prune()` has been added. See above for description.
556 * Introduce reference transactions, which allow multiple references to
557 be locked at the same time and updates be queued. This also allows
558 us to safely update a reflog with arbitrary contents, as we need to
563 * `git_remote_supported_url()` and `git_remote_is_valid_url()` have been
564 removed as they have become essentially useless with rsync-style ssh paths.
566 * `git_clone_into()` and `git_clone_local_into()` have been removed from the
567 public API in favour of `git_clone callbacks`.
569 * The option to ignore certificate errors via `git_remote_cert_check()`
570 is no longer present. Instead, `git_remote_callbacks` has gained a new
571 entry which lets the user perform their own certificate checks.
573 ### Breaking API changes
575 * `git_cherry_pick()` is now `git_cherrypick()`.
577 * The `git_submodule_update()` function was renamed to
578 `git_submodule_update_strategy()`. `git_submodule_update()` is now used to
579 provide functionalty similar to "git submodule update".
581 * `git_treebuilder_create()` was renamed to `git_treebuilder_new()` to better
582 reflect it being a constructor rather than something which writes to
585 * `git_treebuilder_new()` (was `git_treebuilder_create()`) now takes a
586 repository so that it can query repository configuration.
587 Subsequently, `git_treebuilder_write()` no longer takes a repository.
589 * `git_threads_init()` and `git_threads_shutdown()` have been renamed to
590 `git_libgit2_init()` and `git_libgit2_shutdown()` to better explain what
591 their purpose is, as it's grown to be more than just about threads.
593 * `git_libgit2_init()` and `git_libgit2_shutdown()` now return the number of
594 initializations of the library, so consumers may schedule work on the
595 first initialization.
597 * The `git_transport_register()` function no longer takes a priority and takes
598 a URL scheme name (eg "http") instead of a prefix like "http://"
600 * `git_index_name_entrycount()` and `git_index_reuc_entrycount()` now
601 return size_t instead of unsigned int.
603 * The `context_lines` and `interhunk_lines` fields in `git_diff`_options are
604 now `uint32_t` instead of `uint16_t`. This allows to set them to `UINT_MAX`,
605 in effect asking for "infinite" context e.g. to iterate over all the
606 unmodified lines of a diff.
608 * `git_status_file()` now takes an exact path. Use `git_status_list_new()` if
609 pathspec searching is needed.
611 * `git_note_create()` has changed the position of the notes reference
612 name to match `git_note_remove()`.
614 * Rename `git_remote_load()` to `git_remote_lookup()` to bring it in line
615 with the rest of the lookup functions.
617 * `git_remote_rename()` now takes the repository and the remote's
618 current name. Accepting a remote indicates we want to change it,
619 which we only did partially. It is much clearer if we accept a name
620 and no loaded objects are changed.
622 * `git_remote_delete()` now accepts the repository and the remote's name
623 instead of a loaded remote.
625 * `git_merge_head` is now `git_annotated_commit`, to better reflect its usage
626 for multiple functions (including rebase)
628 * The `git_clone_options` struct no longer provides the `ignore_cert_errors` or
629 `remote_name` members for remote customization.
631 Instead, the `git_clone_options` struct has two new members, `remote_cb` and
632 `remote_cb_payload`, which allow the caller to completely override the remote
633 creation process. If needed, the caller can use this callback to give their
634 remote a name other than the default (origin) or disable cert checking.
636 The `remote_callbacks` member has been preserved for convenience, although it
637 is not used when a remote creation callback is supplied.
639 * The `git_clone`_options struct now provides `repository_cb` and
640 `repository_cb_payload` to allow the user to create a repository with
643 * The `git_push` struct to perform a push has been replaced with
644 `git_remote_upload()`. The refspecs and options are passed as a
645 function argument. `git_push_update_tips()` is now also
646 `git_remote_update_tips()` and the callbacks are in the same struct as
649 * The `git_remote_set_transport()` function now sets a transport factory function,
650 rather than a pre-existing transport instance.
652 * The `git_transport` structure definition has moved into the sys/transport.h
655 * libgit2 no longer automatically sets the OpenSSL locking
656 functions. This is not something which we can know to do. A
657 last-resort convenience function is provided in sys/openssl.h,
658 `git_openssl_set_locking()` which can be used to set the locking.