4 This is release v1.1, "Fernweh".
6 ### Changes or improvements
8 * Our bundled PCRE dependency has been updated to 8.44.
10 * The `refs/remotes/origin/HEAD` file will be created at clone time to
11 point to the origin's default branch.
13 * libgit2 now uses the `__atomic_` intrinsics instead of `__sync_`
14 intrinsics on supported gcc and clang versions.
16 * The `init.defaultBranch` setting is now respected and `master` is
17 no longer the hardcoded as the default branch name.
19 * Patch files that do not contain an `index` line can now be parsed.
21 * Configuration files with multi-line values can now contain quotes
22 split across multiple lines.
24 * Windows clients now attempt to use TLS1.3 when available.
26 * Servers that request an upgrade to a newer HTTP version are
27 silently ignored instead of erroneously failing.
29 * Users can pass `NULL` to the options argument to
30 `git_describe_commit`.
32 * Clones and fetches of very large packfiles now succeeds on 32-bit
35 * Custom reference database backends can now handle the repository's
38 * Repositories with a large number of packfiles no longer exhaust the
39 number of file descriptors.
41 * The test framework now supports TAP output when the `-t` flag is
44 * The test framework can now specify an exact match to a test
45 function using a trailing `$`.
47 * All checkout types support `GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH`.
49 * `git_blame` now can ignore whitespace changes using the option
50 `GIT_BLAME_IGNORE_WHITESPACE`.
52 * Several new examples have been created, including an examples for
55 * Mode changes during rename are now supported in patch application.
57 * `git_checkout_head` now correctly removes untracked files in a
58 subdirectory when the `FORCE | REMOVE_UNTRACKED` options are specified.
63 This is a bugfix release with the following changes:
65 - Calculating information about renamed files during merges is more
66 efficient because dissimilarity about files is now being cached and
67 no longer needs to be recomputed.
69 - The `git_worktree_prune_init_options` has been correctly restored for
70 backward compatibility. In v1.0 it was incorrectly deprecated with a
73 - The optional ntlmclient dependency now supports NetBSD.
75 - A bug where attempting to stash on a bare repository may have failed
78 - Configuration files that are unreadable due to permissions are now
79 silently ignored, and treated as if they do not exist. This matches
80 git's behavior; previously this case would have been an error.
82 - v4 index files are now correctly written; previously we would read
83 them correctly but would not write the prefix-compression accurately,
86 - A bug where the smart HTTP transport could not read large data packets
87 has been fixed. Previously, fetching from servers like Gerrit, that
88 sent large data packets, would error.
93 This is release v1.0 "Luftschloss", which is the first stabe release of
94 libgit2. The API will stay compatible across all releases of the same major
95 version. This release includes bugfixes only and supersedes v0.99, which will
96 stop being maintained. Both v0.27 and v0.28 stay supported in accordance with
99 ### Changes or improvements
101 - CMake was converted to make use of the GNUInstallDirs module for both our
102 pkgconfig and install targets in favor of our custom build options
103 `BIN_INSTALL_DIR`, `LIB_INSTALL_DIR` and `INCLUDE_INSTALL_DIR`. Instead, you
104 can now use CMakes standard variables `CMAKE_INSTALL_BINDIR`,
105 `CMAKE_INSTALL_LIBDIR` and `CMAKE_INSTALL_INCLUDEDIR`.
107 - Some CMake build options accepted either a specific value or a boolean value
108 to disable the option altogether or use automatic detection. We only accepted
109 "ON" or "OFF", but none of the other values CMake recognizes as boolean. This
110 was aligned with CMake's understanding of booleans.
112 - The installed pkgconfig file contained incorrect values for both `libdir` and
113 `includedir` variables.
115 - If using pcre2 for regular expressions, then we incorrectly added "pcre2"
116 instead of "pcre2-8" to our pkgconfig dependencies, which was corrected.
118 - Fixed building the bundled ntlmclient dependency on FreeBSD, OpenBSD and
121 - When writing symlinks on Windows, we incorrectly handled relative symlink
122 targets, which was corrected.
124 - When using the HTTP protocol via macOS' SecureTransport implementation, reads
125 could stall at the end of the session and only continue after a timeout of 60
128 - The filesystem-based reference callback didn't corectly initialize the backend
131 - A segmentation fault was fixed when calling `git_blame_buffer()` for files
132 that were modified and added to the index.
134 - A backwards-incompatible change was introduced when we moved some structures
135 from "git2/credentials.h" into "git2/sys/credentials.h". This was fixed in the
136 case where you do not use hard deprecation.
138 - Improved error handling in various places.
144 This is v0.99 "Torschlusspanik". This will be the last minor release
145 before libgit2 v1.0. We expect to only respond to bugs in this release,
146 to stabilize it for next major release.
148 It contains significant refactorings, but is expected to be API-compatible
151 ### Changes or improvements
153 * When fetching from an anonymous remote using a URL with authentication
154 information provided in the URL (eg `https://foo:bar@example.com/repo`),
155 we would erroneously include the literal URL in the FETCH_HEAD file.
156 We now remove that to match git's behavior.
158 * Some credential structures, enums and values have been renamed:
159 `git_cred` is now `git_credential`. `git_credtype_t` is now
160 `git_credential_t`. Functions and types beginning with
161 `git_cred_` now begin with `git_credential`, and constants beginning
162 with `GIT_CREDTYPE` now begin with `GIT_CREDENTIAL`. The former names
165 * Several function signatures have been changed to return an `int` to
166 indicate error conditions. We encourage you to check them for errors
169 * `git_attr_cache_flush`
170 * `git_error_set_str`
171 * `git_index_name_clear`
172 * `git_index_reuc_clear`
173 * `git_libgit2_version`
174 * `git_mempack_reset`
181 * `git_remote_disconnect`
182 * `git_repository__cleanup`
183 * `git_repository_set_config`
184 * `git_repository_set_index`
185 * `git_repository_set_odb`
186 * `git_repository_set_refdb`
187 * `git_revwalk_reset`
188 * `git_revwalk_simplify_first_parent`
189 * `git_revwalk_sorting`
190 * `git_treebuilder_clear`
191 * `git_treebuilder_filter`
193 * The NTLM and Negotiate authentication mechanisms are now supported when
194 talking to git implementations hosted on Apache or nginx servers.
196 * The `HEAD` symbolic reference can no longer be deleted.
198 * `git_merge_driver_source_repo` no longer returns a `const git_repository *`,
199 it now returns a non-`const` `git_repository *`.
201 * Relative symbolic links are now supported on Windows when `core.symlinks`
204 * Servers that provide query parameters with a redirect are now supported.
206 * `git_submodule_sync` will now resolve relative URLs.
208 * When creating git endpoint URLs, double-slashes are no longer used when
209 the given git URL has a trailing slash.
211 * On Windows, a `DllMain` function is no longer included and thread-local
212 storage has moved to fiber-local storage in order to prevent race
213 conditions during shutdown.
215 * The tracing mechanism (`GIT_TRACE`) is now enabled by default and does
216 not need to be explicitly enabled in CMake.
218 * The size of Git objects is now represented by `git_object_size_t`
221 * Binary patches without data can now be parsed.
223 * A configuration snapshot can now be created from another configuration
224 snapshot, not just a "true" configuration object.
226 * The `git_commit_with_signature` API will now ensure that referenced
227 objects exist in the object database.
229 * Stash messages containing newlines will now be replaced with spaces;
230 they will no longer be (erroneously) written to the repository.
232 * `git_commit_create_with_signature` now verifies the commit information
233 to ensure that it points to a valid tree and valid parents.
235 * `git_apply` has an option `GIT_APPLY_CHECK` that will only do a dry-run.
236 The index and working directory will remain unmodified, and application
237 will report if it would have worked.
239 * Patches produced by Mercurial (those that lack some git extended headers)
240 can now be parsed and applied.
242 * Reference locks are obeyed correctly on POSIX platforms, instead of
245 * Patches with empty new files can now be read and applied.
247 * `git_apply_to_tree` can now correctly apply patches that add new files.
249 * The program data configuration on Windows (`C:\ProgramData\Git\config`)
250 must be owned by an administrator, a system account or the current user
253 * `git_blob_filtered_content` is now deprecated in favor of `git_blob_filter`.
255 * Configuration files can now be included conditionally using the
256 `onbranch` conditional.
258 * Checkout can now properly create and remove symbolic links to directories
261 * Stash no longer recomputes trees when committing a worktree, for
262 improved performance.
264 * Repository templates can now include a `HEAD` file to default the
265 initial default branch.
267 * Some configuration structures, enums and values have been renamed:
268 `git_cvar_map` is now `git_configmap`, `git_cvar_t` is now
269 `git_configmap_t`, `GIT_CVAR_FALSE` is now `GIT_CONFIGMAP_FALSE`,
270 `GIT_CVAR_TRUE` is now `GIT_CONFIGMAP_TRUE`, `GIT_CVAR_INT32` is now
271 `GIT_CONFIGMAP_INT32`, and `GIT_CVAR_STRING` is now `GIT_CONFIGMAP_STRING`.
272 The former names are deprecated.
274 * Repositories can now be created at the root of a Windows drive.
276 * Configuration lookups are now more efficiently cached.
278 * `git_commit_create_with_signature` now supports a `NULL` signature,
279 which will create a commit without adding a signature.
281 * When a repository lacks an `info` "common directory", we will no
282 longer erroneously return `GIT_ENOTFOUND` for all attribute lookups.
284 * Several attribute macros have been renamed: `GIT_ATTR_TRUE` is now
285 `GIT_ATTR_IS_TRUE`, `GIT_ATTR_FALSE` is now `GIT_ATTR_IS_FALSE`,
286 `GIT_ATTR_UNSPECIFIED` is now `GIT_ATTR_IS_UNSPECIFIED`. The
287 attribute enum `git_attr_t` is now `git_attr_value_t` and its
288 values have been renamed: `GIT_ATTR_UNSPECIFIED_T` is now
289 `GIT_ATTR_VALUE_UNSPECIFIED`, `GIT_ATTR_TRUE_T` is now
290 `GIT_ATTR_VALUE_TRUE`, `GIT_ATTR_FALSE_T` is now `GIT_ATTR_VALUE_FALSE`,
291 and `GIT_ATTR_VALUE_T` is now `GIT_ATTR_VALUE_STRING`. The
292 former names are deprecated.
294 * `git_object__size` is now `git_object_size`. The former name is
297 * `git_tag_create_frombuffer` is now `git_tag_create_from_buffer`. The
298 former name is deprecated.
300 * Several blob creation functions have been renamed:
301 `git_blob_create_frombuffer` is now named `git_blob_create_from_buffer`,
302 `git_blob_create_fromdisk` is now named `git_blob_create_from_disk`,
303 `git_blob_create_fromworkdir` is now named `git_blob_create_from_workdir`,
304 `git_blob_create_fromstream` is now named `git_blob_create_from_stream`,
305 and `git_blob_create_fromstream_commit` is now named
306 `git_blob_create_from_stream_commit`. The former names are deprecated.
308 * The function `git_oid_iszero` is now named `git_oid_is_zero`. The
309 former name is deprecated.
311 * Pattern matching is now done using `wildmatch` instead of `fnmatch`
312 for compatibility with git.
314 * The option initialization functions suffixed by `init_options` are now
315 suffixed with `options_init`. (For example, `git_checkout_init_options`
316 is now `git_checkout_options_init`.) The former names are deprecated.
318 * NTLM2 authentication is now supported on non-Windows platforms.
320 * The `git_cred_sign_callback` callback is now named `git_cred_sign_cb`.
321 The `git_cred_ssh_interactive_callback` callback is now named
322 `git_cred_ssh_interactive_cb`.
326 * honor escaped trailing whitespace.
327 * do not incorrectly negate sibling paths of a negated pattern.
328 * honor rules that stop ignoring files after a wildcard
330 * Attribute files now:
332 * honor leading and trailing whitespace.
333 * treat paths beginning with `\` as absolute only on Windows.
334 * properly handle escaped characters.
335 * stop reading macros defined in subdirectories
337 * The C locale is now correctly used when parsing regular expressions.
339 * The system PCRE2 or PCRE regular expression libraries are now used
340 when `regcomp_l` is not available on the system. If none of these
341 are available on the system, an included version of PCRE is used.
343 * Wildcards in reference specifications are now supported beyond simply
344 a bare wildcard (`*`) for compatibility with git.
346 * When `git_ignore_path_is_ignored` is provided a path with a trailing
347 slash (eg, `dir/`), it will now treat it as a directory for the
348 purposes of ignore matching.
350 * Patches that add or remove a file with a space in the path can now
353 * The `git_remote_completion_type` type is now `git_remote_completion_t`.
354 The former name is deprecated.
356 * The `git_odb_backend_malloc` is now `git_odb_backend_data_alloc`. The
357 former name is deprecated.
359 * The `git_transfer_progress_cb` callback is now `git_indexer_progress_cb`
360 and the `git_transfer_progress` structure is now `git_indexer_progress`.
361 The former names are deprecated.
363 * The example projects are now contained in a single `lg2` executable
366 * libgit2 now correctly handles more URLs, such as
367 `http://example.com:/repo.git` (colon but no port),
368 `http://example.com` (no path),
369 and `http://example.com:8080/` (path is /, nonstandard port).
371 * A carefully constructed commit object with a very large number
372 of parents may lead to potential out-of-bounds writes or
373 potential denial of service.
375 * The ProgramData configuration file is always read for compatibility
376 with Git for Windows and Portable Git installations. The ProgramData
377 location is not necessarily writable only by administrators, so we
378 now ensure that the configuration file is owned by the administrator
383 * The SSH host key now supports SHA-256 when `GIT_CERT_SSH_SHA256` is set.
385 * The diff format option `GIT_DIFF_FORMAT_PATCH_ID` can now be used to
386 emit an output like `git patch-id`.
388 * The `git_apply_options_init` function will initialize a
389 `git_apply_options` structure.
391 * The remote callbacks structure adds a `git_url_resolve_cb` callback
392 that is invoked when connecting to a server, so that applications
393 may edit or replace the URL before connection.
395 * The information about the original `HEAD` in a rebase operation is
396 available with `git_rebase_orig_head_name`. Its ID is available with
397 `git_rebase_orig_head_id`. The `onto` reference name is available with
398 `git_rebase_onto_name` and its ID is available with `git_rebase_onto_id`.
400 * ODB backends can now free backend data when an error occurs during its
401 backend data creation using `git_odb_backend_data_free`.
403 * Options may be specified to `git_repository_foreach_head` to control
404 its behavior: `GIT_REPOSITORY_FOREACH_HEAD_SKIP_REPO` will not skip
405 the main repository's HEAD reference, while
406 `GIT_REPOSITORY_FOREACH_HEAD_SKIP_WORKTREES` will now skip the
407 worktree HEAD references.
409 * The `GIT_OPT_DISABLE_PACK_KEEP_FILE_CHECKS` option can be specified to
410 `git_libgit2_opts()` to avoid looking for `.keep` files that correspond
411 to packfiles. This setting can improve performance when packfiles are
412 stored on high-latency filesystems like network filesystems.
414 * Blobs can now be filtered with `git_blob_filter`, which allows for
415 options to be set with `git_blob_filter_options`, including
416 `GIT_FILTER_NO_SYSTEM_ATTRIBUTES` to disable filtering with system-level
417 attributes in `/etc/gitattributes` and `GIT_ATTR_CHECK_INCLUDE_HEAD` to
418 enable filtering with `.gitattributes` files in the HEAD revision.
422 * The unused `git_headlist_cb` function declaration was removed.
424 * The unused `git_time_monotonic` API is removed.
426 * The erroneously exported `inttypes.h` header was removed.
430 - CVE-2019-1348: the fast-import stream command "feature
431 export-marks=path" allows writing to arbitrary file paths. As
432 libgit2 does not offer any interface for fast-import, it is not
433 susceptible to this vulnerability.
435 - CVE-2019-1349: by using NTFS 8.3 short names, backslashes or
436 alternate filesystreams, it is possible to cause submodules to
437 be written into pre-existing directories during a recursive
438 clone using git. As libgit2 rejects cloning into non-empty
439 directories by default, it is not susceptible to this
442 - CVE-2019-1350: recursive clones may lead to arbitrary remote
443 code executing due to improper quoting of command line
444 arguments. As libgit2 uses libssh2, which does not require us
445 to perform command line parsing, it is not susceptible to this
448 - CVE-2019-1351: Windows provides the ability to substitute
449 drive letters with arbitrary letters, including multi-byte
450 Unicode letters. To fix any potential issues arising from
451 interpreting such paths as relative paths, we have extended
452 detection of DOS drive prefixes to accomodate for such cases.
454 - CVE-2019-1352: by using NTFS-style alternative file streams for
455 the ".git" directory, it is possible to overwrite parts of the
456 repository. While this has been fixed in the past for Windows,
457 the same vulnerability may also exist on other systems that
458 write to NTFS filesystems. We now reject any paths starting
459 with ".git:" on all systems.
461 - CVE-2019-1353: by using NTFS-style 8.3 short names, it was
462 possible to write to the ".git" directory and thus overwrite
463 parts of the repository, leading to possible remote code
464 execution. While this problem was already fixed in the past for
465 Windows, other systems accessing NTFS filesystems are
466 vulnerable to this issue too. We now enable NTFS protecions by
467 default on all systems to fix this attack vector.
469 - CVE-2019-1354: on Windows, backslashes are not a valid part of
470 a filename but are instead interpreted as directory separators.
471 As other platforms allowed to use such paths, it was possible
472 to write such invalid entries into a Git repository and was
473 thus an attack vector to write into the ".git" dierctory. We
474 now reject any entries starting with ".git\" on all systems.
476 - CVE-2019-1387: it is possible to let a submodule's git
477 directory point into a sibling's submodule directory, which may
478 result in overwriting parts of the Git repository and thus lead
479 to arbitrary command execution. As libgit2 doesn't provide any
480 way to do submodule clones natively, it is not susceptible to
481 this vulnerability. Users of libgit2 that have implemented
482 recursive submodule clones manually are encouraged to review
483 their implementation for this vulnerability.
485 ### Breaking API changes
487 * The "private" implementation details of the `git_cred` structure have been
488 moved to a dedicated `git2/sys/cred.h` header, to clarify that the underlying
489 structures are only provided for custom transport implementers.
490 The breaking change is that the `username` member of the underlying struct
491 is now hidden, and a new `git_cred_get_username` function has been provided.
493 ### Breaking CMake configuration changes
495 * The CMake option to use a system http-parser library, instead of the
496 bundled dependency, has changed. This is due to a deficiency in
497 http-parser that we have fixed in our implementation. The bundled
498 library is now the default, but if you wish to force the use of the
499 system http-parser implementation despite incompatibilities, you can
500 specify `-DUSE_HTTP_PARSER=system` to CMake.
502 * The interactions between `USE_HTTPS` and `SHA1_BACKEND` have been
503 streamlined. The detection was moved to a new `USE_SHA1`, modeled after
504 `USE_HTTPS`, which takes the values "CollisionDetection/Backend/Generic", to
505 better match how the "hashing backend" is selected, the default (ON) being
506 "CollisionDetection". If you were using `SHA1_BACKEND` previously, you'll
507 need to check the value you've used, or switch to the autodetection.
511 The following individuals provided changes that were included in this
522 * Carlos MartÃn Nieto
530 * Dhruva Krishnamurthy
541 * Janardhan Pulivarthi
543 * Johannes Schindelin
545 * Josh Bleecher Snyder
569 ### Changes or improvements
571 * The library is now always built with cdecl calling conventions on
572 Windows; the ability to build a stdcall library has been removed.
574 * Reference log creation now honors `core.logallrefupdates=always`.
576 * Fix some issues with the error-reporting in the OpenSSL backend.
578 * HTTP proxy support is now builtin; libcurl is no longer used to support
579 proxies and is removed as a dependency.
581 * Certificate and credential callbacks can now return `GIT_PASSTHROUGH`
582 to decline to act; libgit2 will behave as if there was no callback set
585 * The line-ending filtering logic - when checking out files - has been
586 updated to match newer git (>= git 2.9) for proper interoperability.
588 * Symbolic links are now supported on Windows when `core.symlinks` is set
591 * Submodules with names which attempt to perform path traversal now have their
592 configuration ignored. Such names were blindly appended to the
593 `$GIT_DIR/modules` and a malicious name could lead to an attacker writing to
594 an arbitrary location. This matches git's handling of CVE-2018-11235.
596 * Object validation is now performed during tree creation in the
597 `git_index_write_tree_to` API.
599 * Configuration variable may now be specified on the same line as a section
600 header; previously this was erroneously a parser error.
602 * When an HTTP server supports both NTLM and Negotiate authentication
603 mechanisms, we would previously fail to authenticate with any mechanism.
605 * The `GIT_OPT_SET_PACK_MAX_OBJECTS` option can now set the maximum
606 number of objects allowed in a packfile being downloaded; this can help
607 limit the maximum memory used when fetching from an untrusted remote.
609 * Line numbers in diffs loaded from patch files were not being populated;
610 they are now included in the results.
612 * The repository's index is reloaded from disk at the beginning of
613 `git_merge` operations to ensure that it is up-to-date.
615 * Mailmap handling APIs have been introduced, and the new commit APIs
616 `git_commit_committer_with_mailmap` and `git_commit_author_with_mailmap`
617 will use the mailmap to resolve the committer and author information.
618 In addition, blame will use the mailmap given when the
619 `GIT_BLAME_USE_MAILMAP` option.
621 * Ignore handling for files in ignored folders would be ignored.
623 * Worktrees can now be backed by bare repositories.
625 * Trailing spaces are supported in `.gitignore` files, these spaces were
626 previously (and erroneously) treated as part of the pattern.
628 * The library can now be built with mbedTLS support for HTTPS.
630 * The diff status character 'T' will now be presented by the
631 `git_diff_status_char` API for diff entries that change type.
633 * Revision walks previously would sometimes include commits that should
634 have been ignored; this is corrected.
636 * Revision walks are now more efficient when the output is unsorted;
637 we now avoid walking all the way to the beginning of history unnecessarily.
639 * Error-handling around index extension loading has been fixed. We were
640 previously always misreporting a truncated index (#4858).
644 * The index may now be iterated atomically using `git_index_iterator`.
646 * Remote objects can now be created with extended options using the
647 `git_remote_create_with_opts` API.
649 * Diff objects can now be applied as changes to the working directory,
650 index or both, emulating the `git apply` command. Additionally,
651 `git_apply_to_tree` can apply those changes to a tree object as a
652 fully in-memory operation.
654 * You can now swap out memory allocators via the
655 `GIT_OPT_SET_ALLOCATOR` option with `git_libgit2_opts()`.
657 * You can now ensure that functions do not discard unwritten changes to the
658 index via the `GIT_OPT_ENABLE_UNSAVED_INDEX_SAFETY` option to
659 `git_libgit2_opts()`. This will cause functions that implicitly re-read
660 the index (eg, `git_checkout`) to fail if you have staged changes to the
661 index but you have not written the index to disk. (Unless the checkout
662 has the FORCE flag specified.)
664 At present, this defaults to off, but we intend to enable this more
665 broadly in the future, as a warning or error. We encourage you to
666 examine your code to ensure that you are not relying on the current
667 behavior that implicitly removes staged changes.
669 * Reference specifications can be parsed from an arbitrary string with
670 the `git_refspec_parse` API.
672 * You can now get the name and path of worktrees using the
673 `git_worktree_name` and `git_worktree_path` APIs, respectively.
675 * The `ref` field has been added to `git_worktree_add_options` to enable
676 the creation of a worktree from a pre-existing branch.
678 * It's now possible to analyze merge relationships between any two
679 references, not just against `HEAD`, using `git_merge_analysis_for_ref`.
683 * The `git_buf_free` API is deprecated; it has been renamed to
684 `git_buf_dispose` for consistency. The `git_buf_free` API will be
685 retained for backward compatibility for the foreseeable future.
687 * The `git_otype` enumeration and its members are deprecated and have
688 been renamed for consistency. The `GIT_OBJ_` enumeration values are
689 now prefixed with `GIT_OBJECT_`. The old enumerations and macros
690 will be retained for backward compatibility for the foreseeable future.
692 * Several index-related APIs have been renamed for consistency. The
693 `GIT_IDXENTRY_` enumeration values and macros have been renamed to
694 be prefixed with `GIT_INDEX_ENTRY_`. The `GIT_INDEXCAP` enumeration
695 values are now prefixed with `GIT_INDEX_CAPABILITY_`. The old
696 enumerations and macros will be retained for backward compatibility
697 for the foreseeable future.
699 * The error functions and enumeration values have been renamed for
700 consistency. The `giterr_` functions and values prefix have been
701 renamed to be prefixed with `git_error_`; similarly, the `GITERR_`
702 constants have been renamed to be prefixed with `GIT_ERROR_`.
703 The old enumerations and macros will be retained for backward
704 compatibility for the foreseeable future.
706 ### Breaking API changes
708 * The default checkout strategy changed from `DRY_RUN` to `SAFE` (#4531).
710 * Adding a symlink as .gitmodules into the index from the workdir or checking
711 out such files is not allowed as this can make a Git implementation write
712 outside of the repository and bypass the fsck checks for CVE-2018-11235.
717 ### Changes or improvements
719 * Improved `p_unlink` in `posix_w32.c` to try and make a file writable
720 before sleeping in the retry loop to prevent unnecessary calls to sleep.
722 * The CMake build infrastructure has been improved to speed up building time.
724 * A new CMake option "-DUSE_HTTPS=<backend>" makes it possible to explicitly
725 choose an HTTP backend.
727 * A new CMake option "-DSHA1_BACKEND=<backend>" makes it possible to explicitly
728 choose an SHA1 backend. The collision-detecting backend is now the default.
730 * A new CMake option "-DUSE_BUNDLED_ZLIB" makes it possible to explicitly use
731 the bundled zlib library.
733 * A new CMake option "-DENABLE_REPRODUCIBLE_BUILDS" makes it possible to
734 generate a reproducible static archive. This requires support from your
737 * The minimum required CMake version has been bumped to 2.8.11.
739 * Writing to a configuration file now preserves the case of the key given by the
740 caller for the case-insensitive portions of the key (existing sections are
741 used even if they don't match).
743 * We now support conditional includes in configuration files.
745 * Fix for handling re-reading of configuration files with includes.
747 * Fix for reading patches which contain exact renames only.
749 * Fix for reading patches with whitespace in the compared files' paths.
751 * We will now fill `FETCH_HEAD` from all passed refspecs instead of overwriting
754 * There is a new diff option, `GIT_DIFF_INDENT_HEURISTIC` which activates a
755 heuristic which takes into account whitespace and indentation in order to
756 produce better diffs when dealing with ambiguous diff hunks.
758 * Fix for pattern-based ignore rules where files ignored by a rule cannot be
759 un-ignored by another rule.
761 * Sockets opened by libgit2 are now being closed on exec(3) if the platform
764 * Fix for peeling annotated tags from packed-refs files.
766 * Fix reading huge loose objects from the object database.
768 * Fix files not being treated as modified when only the file mode has changed.
770 * We now explicitly reject adding submodules to the index via
771 `git_index_add_frombuffer`.
773 * Fix handling of `GIT_DIFF_FIND_RENAMES_FROM_REWRITES` raising `SIGABRT` when
774 one file has been deleted and another file has been rewritten.
776 * Fix for WinHTTP not properly handling NTLM and Negotiate challenges.
778 * When using SSH-based transports, we now repeatedly ask for the passphrase to
779 decrypt the private key in case a wrong passphrase is being provided.
781 * When generating conflict markers, they will now use the same line endings as
782 the rest of the file.
786 * The `git_merge_file_options` structure now contains a new setting,
787 `marker_size`. This allows users to set the size of markers that
788 delineate the sides of merged files in the output conflict file.
789 By default this is 7 (`GIT_MERGE_CONFLICT_MARKER_SIZE`), which
790 produces output markers like `<<<<<<<` and `>>>>>>>`.
792 * `git_remote_create_detached()` creates a remote that is not associated
793 to any repository (and does not apply configuration like 'insteadof' rules).
794 This is mostly useful for e.g. emulating `git ls-remote` behavior.
796 * `git_diff_patchid()` lets you generate patch IDs for diffs.
798 * `git_status_options` now has an additional field `baseline` to allow creating
799 status lists against different trees.
801 * New family of functions to allow creating notes for a specific notes commit
802 instead of for a notes reference.
804 * New family of functions to allow parsing message trailers. This API is still
805 experimental and may change in future releases.
809 ### Breaking API changes
811 * Signatures now distinguish between +0000 and -0000 UTC offsets.
813 * The certificate check callback in the WinHTTP transport will now receive the
814 `message_cb_payload` instead of the `cred_acquire_payload`.
816 * We are now reading symlinked directories under .git/refs.
818 * We now refuse creating branches named "HEAD".
820 * We now refuse reading and writing all-zero object IDs into the
823 * We now read the effective user's configuration file instead of the real user's
824 configuration in case libgit2 runs as part of a setuid binary.
826 * The `git_odb_open_rstream` function and its `readstream` callback in the
827 `git_odb_backend` interface have changed their signatures to allow providing
828 the object's size and type to the caller.
833 ### Changes or improvements
835 * Support for opening, creating and modifying worktrees.
837 * We can now detect SHA1 collisions resulting from the SHAttered attack. These
838 checks can be enabled at build time via `-DUSE_SHA1DC`.
840 * Fix for missing implementation of `git_merge_driver_source` getters.
842 * Fix for installed pkg-config file being broken when the prefix contains
845 * We now detect when the hashsum of on-disk objects does not match their
848 * We now support open-ended ranges (e.g. "master..", "...master") in our
849 revision range parsing code.
851 * We now correctly compute ignores with leading "/" in subdirectories.
853 * We now optionally call `fsync` on loose objects, packfiles and their indexes,
854 loose references and packed reference files.
856 * We can now build against OpenSSL v1.1 and against LibreSSL.
858 * `GIT_MERGE_OPTIONS_INIT` now includes a setting to perform rename detection.
859 This aligns this structure with the default by `git_merge` and
860 `git_merge_trees` when `NULL` was provided for the options.
862 * Improvements for reading index v4 files.
864 * Perform additional retries for filesystem operations on Windows when files
865 are temporarily locked by other processes.
869 * New family of functions to handle worktrees:
871 * `git_worktree_list()` lets you look up worktrees for a repository.
872 * `git_worktree_lookup()` lets you get a specific worktree.
873 * `git_worktree_open_from_repository()` lets you get the associated worktree
876 * `git_worktree_add` lets you create new worktrees.
877 * `git_worktree_prune` lets you remove worktrees from disk.
878 * `git_worktree_lock()` and `git_worktree_unlock()` let you lock
879 respectively unlock a worktree.
880 * `git_repository_open_from_worktree()` lets you open a repository via
881 * `git_repository_head_for_worktree()` lets you get the current `HEAD` for a
883 * `git_repository_head_detached_for_worktree()` lets you check whether a
884 linked worktree is in detached HEAD mode.
886 * `git_repository_item_path()` lets you retrieve paths for various repository
889 * `git_repository_commondir()` lets you retrieve the common directory of a
892 * `git_branch_is_checked_out()` allows you to check whether a branch is checked
893 out in a repository or any of its worktrees.
895 * `git_repository_submodule_cache_all()` and
896 `git_repository_submodule_cache_clear()` functions allow you to prime or clear
897 the submodule cache of a repository.
899 * You can disable strict hash verifications via the
900 `GIT_OPT_ENABLE_STRICT_HASH_VERIFICATION` option with `git_libgit2_opts()`.
902 * You can enable us calling `fsync` for various files inside the ".git"
903 directory by setting the `GIT_OPT_ENABLE_FSYNC_GITDIR` option with
904 `git_libgit2_opts()`.
906 * You can now enable "offset deltas" when creating packfiles and negotiating
907 packfiles with a remote server by setting `GIT_OPT_ENABLE_OFS_DELTA` option
908 with `GIT_libgit2_opts()`.
910 * You can now set the default share mode on Windows for opening files using
911 `GIT_OPT_SET_WINDOWS_SHAREMODE` option with `git_libgit2_opts()`.
912 You can query the current share mode with `GIT_OPT_GET_WINDOWS_SHAREMODE`.
914 * `git_transport_smart_proxy_options()' enables you to get the proxy options for
917 * The `GIT_FILTER_INIT` macro and the `git_filter_init` function are provided
918 to initialize a `git_filter` structure.
920 ### Breaking API changes
922 * `clone_checkout_strategy` has been removed from
923 `git_submodule_update_option`. The checkout strategy used to clone will
924 be the same strategy specified in `checkout_opts`.
929 ### Changes or improvements
931 * Fix repository discovery with `git_repository_discover` and
932 `git_repository_open_ext` to match git's handling of a ceiling
933 directory at the current directory. git only checks ceiling
934 directories when its search ascends to a parent directory. A ceiling
935 directory matching the starting directory will not prevent git from
936 finding a repository in the starting directory or a parent directory.
938 * Do not fail when deleting remotes in the presence of broken
939 global configs which contain branches.
941 * Support for reading and writing git index v4 files
943 * Improve the performance of the revwalk and bring us closer to git's code.
945 * The reference db has improved support for concurrency and returns `GIT_ELOCKED`
946 when an operation could not be performed due to locking.
948 * Nanosecond resolution is now activated by default, following git's change to
951 * We now restrict the set of ciphers we let OpenSSL use by default.
953 * Users can now register their own merge drivers for use with `.gitattributes`.
954 The library also gained built-in support for the union merge driver.
956 * The default for creating references is now to validate that the object does
959 * Add `git_proxy_options` which is used by the different networking
960 implementations to let the caller specify the proxy settings instead of
961 relying on the environment variables.
965 * You can now get the user-agent used by libgit2 using the
966 `GIT_OPT_GET_USER_AGENT` option with `git_libgit2_opts()`.
967 It is the counterpart to `GIT_OPT_SET_USER_AGENT`.
969 * The `GIT_OPT_SET_SSL_CIPHERS` option for `git_libgit2_opts()` lets you specify
970 a custom list of ciphers to use for OpenSSL.
972 * `git_commit_create_buffer()` creates a commit and writes it into a
973 user-provided buffer instead of writing it into the object db. Combine it with
974 `git_commit_create_with_signature()` in order to create a commit with a
975 cryptographic signature.
977 * `git_blob_create_fromstream()` and
978 `git_blob_create_fromstream_commit()` allow you to create a blob by
979 writing into a stream. Useful when you do not know the final size or
980 want to copy the contents from another stream.
982 * New flags for `git_repository_open_ext`:
984 * `GIT_REPOSITORY_OPEN_NO_DOTGIT` - Do not check for a repository by
985 appending `/.git` to the `start_path`; only open the repository if
986 `start_path` itself points to the git directory.
987 * `GIT_REPOSITORY_OPEN_FROM_ENV` - Find and open a git repository,
988 respecting the environment variables used by the git command-line
989 tools. If set, `git_repository_open_ext` will ignore the other
990 flags and the `ceiling_dirs` argument, and will allow a NULL
991 `path` to use `GIT_DIR` or search from the current directory. The
992 search for a repository will respect `$GIT_CEILING_DIRECTORIES`
993 and `$GIT_DISCOVERY_ACROSS_FILESYSTEM`. The opened repository
994 will respect `$GIT_INDEX_FILE`, `$GIT_NAMESPACE`,
995 `$GIT_OBJECT_DIRECTORY`, and `$GIT_ALTERNATE_OBJECT_DIRECTORIES`.
996 In the future, this flag will also cause `git_repository_open_ext`
997 to respect `$GIT_WORK_TREE` and `$GIT_COMMON_DIR`; currently,
998 `git_repository_open_ext` with this flag will error out if either
999 `$GIT_WORK_TREE` or `$GIT_COMMON_DIR` is set.
1001 * `git_diff_from_buffer()` can create a `git_diff` object from the contents
1002 of a git-style patch file.
1004 * `git_index_version()` and `git_index_set_version()` to get and set
1007 * `git_odb_expand_ids()` lets you check for the existence of multiple
1010 * The new `git_blob_dup()`, `git_commit_dup()`, `git_tag_dup()` and
1011 `git_tree_dup()` functions provide type-specific wrappers for
1012 `git_object_dup()` to reduce noise and increase type safety for callers.
1014 * `git_reference_dup()` lets you duplicate a reference to aid in ownership
1015 management and cleanup.
1017 * `git_signature_from_buffer()` lets you create a signature from a string in the
1018 format that appear in objects.
1020 * `git_tree_create_updated()` lets you create a tree based on another one
1021 together with a list of updates. For the covered update cases, it's more
1022 efficient than the `git_index` route.
1024 * `git_apply_patch()` applies hunks from a `git_patch` to a buffer.
1026 * `git_diff_to_buf()` lets you print an entire diff directory to a buffer,
1027 similar to how `git_patch_to_buf()` works.
1029 * `git_proxy_init_options()` is added to initialize a `git_proxy_options`
1030 structure at run-time.
1032 * `git_merge_driver_register()`, `git_merge_driver_unregister()` let you
1033 register and unregister a custom merge driver to be used when `.gitattributes`
1036 * `git_merge_driver_lookup()` can be used to look up a merge driver by name.
1038 * `git_merge_driver_source_repo()`, `git_merge_driver_source_ancestor()`,
1039 `git_merge_driver_source_ours()`, `git_merge_driver_source_theirs()`,
1040 `git_merge_driver_source_file_options()` added as accessors to
1041 `git_merge_driver_source`.
1045 * `git_blob_create_fromchunks()` has been removed in favour of
1046 `git_blob_create_fromstream()`.
1048 ### Breaking API changes
1050 * `git_packbuilder_object_count` and `git_packbuilder_written` now
1051 return a `size_t` instead of a `uint32_t` for more thorough
1052 compatibility with the rest of the library.
1054 * `git_packbuiler_progress` now provides explicitly sized `uint32_t`
1055 values instead of `unsigned int`.
1057 * `git_diff_file` now includes an `id_abbrev` field that reflects the
1058 number of nibbles set in the `id` field.
1060 * `git_odb_backend` now has a `freshen` function pointer. This optional
1061 function pointer is similar to the `exists` function, but it will update
1062 a last-used marker. For filesystem-based object databases, this updates
1063 the timestamp of the file containing the object, to indicate "freshness".
1064 If this is `NULL`, then it will not be called and the `exists` function
1065 will be used instead.
1067 * `git_remote_connect()` now accepts `git_proxy_options` argument, and
1068 `git_fetch_options` and `git_push_options` each have a `proxy_opts` field.
1070 * `git_merge_options` now provides a `default_driver` that can be used
1071 to provide the name of a merge driver to be used to handle files changed
1077 ### Changes or improvements
1079 * Custom merge drivers can now be registered, which allows callers to
1080 configure callbacks to honor `merge=driver` configuration in
1083 * Custom filters can now be registered with wildcard attributes, for
1084 example `filter=*`. Consumers should examine the attributes parameter
1085 of the `check` function for details.
1087 * Symlinks are now followed when locking a file, which can be
1088 necessary when multiple worktrees share a base repository.
1090 * You can now set your own user-agent to be sent for HTTP requests by
1091 using the `GIT_OPT_SET_USER_AGENT` with `git_libgit2_opts()`.
1093 * You can set custom HTTP header fields to be sent along with requests
1094 by passing them in the fetch and push options.
1096 * Tree objects are now assumed to be sorted. If a tree is not
1097 correctly formed, it will give bad results. This is the git approach
1098 and cuts a significant amount of time when reading the trees.
1100 * Filter registration is now protected against concurrent
1103 * Filenames which are not valid on Windows in an index no longer cause
1104 to fail to parse it on that OS.
1106 * Rebases can now be performed purely in-memory, without touching the
1107 repository's workdir.
1109 * When adding objects to the index, or when creating new tree or commit
1110 objects, the inputs are validated to ensure that the dependent objects
1111 exist and are of the correct type. This object validation can be
1112 disabled with the GIT_OPT_ENABLE_STRICT_OBJECT_CREATION option.
1114 * The WinHTTP transport's handling of bad credentials now behaves like
1115 the others, asking for credentials again.
1119 * `git_config_lock()` has been added, which allow for
1120 transactional/atomic complex updates to the configuration, removing
1121 the opportunity for concurrent operations and not committing any
1122 changes until the unlock.
1124 * `git_diff_options` added a new callback `progress_cb` to report on the
1125 progress of the diff as files are being compared. The documentation of
1126 the existing callback `notify_cb` was updated to reflect that it only
1127 gets called when new deltas are added to the diff.
1129 * `git_fetch_options` and `git_push_options` have gained a `custom_headers`
1130 field to set the extra HTTP header fields to send.
1132 * `git_stream_register_tls()` lets you register a callback to be used
1133 as the constructor for a TLS stream instead of the libgit2 built-in
1136 * `git_commit_header_field()` allows you to look up a specific header
1139 * `git_commit_extract_signature()` extracts the signature from a
1140 commit and gives you both the signature and the signed data so you
1145 * No APIs were removed in this version.
1147 ### Breaking API changes
1149 * The `git_merge_tree_flag_t` is now `git_merge_flag_t`. Subsequently,
1150 its members are no longer prefixed with `GIT_MERGE_TREE_FLAG` but are
1151 now prefixed with `GIT_MERGE_FLAG`, and the `tree_flags` field of the
1152 `git_merge_options` structure is now named `flags`.
1154 * The `git_merge_file_flags_t` enum is now `git_merge_file_flag_t` for
1155 consistency with other enum type names.
1157 * `git_cert` descendent types now have a proper `parent` member
1159 * It is the responsibility of the refdb backend to decide what to do
1160 with the reflog on ref deletion. The file-based backend must delete
1161 it, a database-backed one may wish to archive it.
1163 * `git_config_backend` has gained two entries. `lock` and `unlock`
1164 with which to implement the transactional/atomic semantics for the
1165 configuration backend.
1167 * `git_index_add` and `git_index_conflict_add()` will now use the case
1168 as provided by the caller on case insensitive systems. Previous
1169 versions would keep the case as it existed in the index. This does
1170 not affect the higher-level `git_index_add_bypath` or
1171 `git_index_add_frombuffer` functions.
1173 * The `notify_payload` field of `git_diff_options` was renamed to `payload`
1174 to reflect that it's also the payload for the new progress callback.
1176 * The `git_config_level_t` enum has gained a higher-priority value
1177 `GIT_CONFIG_LEVEL_PROGRAMDATA` which represent a rough Windows equivalent
1178 to the system level configuration.
1180 * `git_rebase_options` now has a `merge_options` field.
1182 * The index no longer performs locking itself. This is not something
1183 users of the library should have been relying on as it's not part of
1184 the concurrency guarantees.
1186 * `git_remote_connect()` now takes a `custom_headers` argument to set
1187 the extra HTTP header fields to send.
1192 ### Changes or improvements
1194 * Patience and minimal diff drivers can now be used for merges.
1196 * Merges can now ignore whitespace changes.
1198 * Updated binary identification in CRLF filtering to avoid false positives in
1201 * Rename and copy detection is enabled for small files.
1203 * Checkout can now handle an initial checkout of a repository, making
1204 `GIT_CHECKOUT_SAFE_CREATE` unnecessary for users of clone.
1206 * The signature parameter in the ref-modifying functions has been
1207 removed. Use `git_repository_set_ident()` and
1208 `git_repository_ident()` to override the signature to be used.
1210 * The local transport now auto-scales the number of threads to use
1211 when creating the packfile instead of sticking to one.
1213 * Reference renaming now uses the right id for the old value.
1215 * The annotated version of branch creation, HEAD detaching and reset
1216 allow for specifying the expression from the user to be put into the
1219 * `git_rebase_commit` now returns `GIT_EUNMERGED` when you attempt to
1220 commit with unstaged changes.
1222 * On Mac OS X, we now use SecureTransport to provide the cryptographic
1223 support for HTTPS connections insead of OpenSSL.
1225 * Checkout can now accept an index for the baseline computations via the
1226 `baseline_index` member.
1228 * The configuration for fetching is no longer stored inside the
1229 `git_remote` struct but has been moved to a `git_fetch_options`. The
1230 remote functions now take these options or the callbacks instead of
1231 setting them beforehand.
1233 * `git_submodule` instances are no longer cached or shared across
1234 lookup. Each submodule represents the configuration at the time of
1237 * The index now uses diffs for `add_all()` and `update_all()` which
1238 gives it a speed boost and closer semantics to git.
1240 * The ssh transport now reports the stderr output from the server as
1241 the error message, which allows you to get the "repository not
1244 * `git_index_conflict_add()` will remove staged entries that exist for
1247 * The flags for a `git_diff_file` will now have the `GIT_DIFF_FLAG_EXISTS`
1248 bit set when a file exists on that side of the diff. This is useful
1249 for understanding whether a side of the diff exists in the presence of
1252 * The constructor for a write-stream into the odb now takes
1253 `git_off_t` instead of `size_t` for the size of the blob, which
1254 allows putting large files into the odb on 32-bit systems.
1256 * The remote's push and pull URLs now honor the url.$URL.insteadOf
1257 configuration. This allows modifying URL prefixes to a custom
1258 value via gitconfig.
1260 * `git_diff_foreach`, `git_diff_blobs`, `git_diff_blob_to_buffer`,
1261 and `git_diff_buffers` now accept a new binary callback of type
1262 `git_diff_binary_cb` that includes the binary diff information.
1264 * The race condition mitigations described in `racy-git.txt` have been
1267 * If libcurl is installed, we will use it to connect to HTTP(S)
1272 * The `git_merge_options` gained a `file_flags` member.
1274 * Parsing and retrieving a configuration value as a path is exposed
1275 via `git_config_parse_path()` and `git_config_get_path()`
1278 * `git_repository_set_ident()` and `git_repository_ident()` serve to
1279 set and query which identity will be used when writing to the
1282 * `git_config_entry_free()` frees a config entry.
1284 * `git_config_get_string_buf()` provides a way to safely retrieve a
1285 string from a non-snapshot configuration.
1287 * `git_annotated_commit_from_revspec()` allows to get an annotated
1288 commit from an extended sha synatx string.
1290 * `git_repository_set_head_detached_from_annotated()`,
1291 `git_branch_create_from_annotated()` and
1292 `git_reset_from_annotated()` allow for the caller to provide an
1293 annotated commit through which they can control what expression is
1294 put into the reflog as the source/target.
1296 * `git_index_add_frombuffer()` can now create a blob from memory
1297 buffer and add it to the index which is attached to a repository.
1299 * The structure `git_fetch_options` has been added to determine the
1300 runtime configuration for fetching, such as callbacks, pruning and
1301 autotag behaviour. It has the runtime initializer
1302 `git_fetch_init_options()`.
1304 * The enum `git_fetch_prune_t` has been added, letting you specify the
1305 pruning behaviour for a fetch.
1307 * A push operation will notify the caller of what updates it indends
1308 to perform on the remote, which provides similar information to
1309 git's pre-push hook.
1311 * `git_stash_apply()` can now apply a stashed state from the stash list,
1312 placing the data into the working directory and index.
1314 * `git_stash_pop()` will apply a stashed state (like `git_stash_apply()`)
1315 but will remove the stashed state after a successful application.
1317 * A new error code `GIT_EEOF` indicates an early EOF from the
1318 server. This typically indicates an error with the URL or
1319 configuration of the server, and tools can use this to show messages
1320 about failing to communicate with the server.
1322 * A new error code `GIT_EINVALID` indicates that an argument to a
1323 function is invalid, or an invalid operation was requested.
1325 * `git_diff_index_to_workdir()` and `git_diff_tree_to_index()` will now
1326 produce deltas of type `GIT_DELTA_CONFLICTED` to indicate that the index
1327 side of the delta is a conflict.
1329 * The `git_status` family of functions will now produce status of type
1330 `GIT_STATUS_CONFLICTED` to indicate that a conflict exists for that file
1333 * `git_index_entry_is_conflict()` is a utility function to determine if
1334 a given index entry has a non-zero stage entry, indicating that it is
1335 one side of a conflict.
1337 * It is now possible to pass a keypair via a buffer instead of a
1338 path. For this, `GIT_CREDTYPE_SSH_MEMORY` and
1339 `git_cred_ssh_key_memory_new()` have been added.
1341 * `git_filter_list_contains` will indicate whether a particular
1342 filter will be run in the given filter list.
1344 * `git_commit_header_field()` has been added, which allows retrieving
1345 the contents of an arbitrary header field.
1347 * `git_submodule_set_branch()` allows to set the configured branch for
1352 * `git_remote_save()` and `git_remote_clear_refspecs()` have been
1353 removed. Remote's configuration is changed via the configuration
1354 directly or through a convenience function which performs changes to
1355 the configuration directly.
1357 * `git_remote_set_callbacks()`, `git_remote_get_callbacks()` and
1358 `git_remote_set_transport()` have been removed and the remote no
1359 longer stores this configuration.
1361 * `git_remote_set_fetch_refpecs()` and
1362 `git_remote_set_push_refspecs()` have been removed. There is no
1363 longer a way to set the base refspecs at run-time.
1365 * `git_submodule_save()` has been removed. The submodules are no
1366 longer configured via the objects.
1368 * `git_submodule_reload_all()` has been removed as we no longer cache
1371 ### Breaking API changes
1373 * `git_smart_subtransport_cb` now has a `param` parameter.
1375 * The `git_merge_options` structure member `flags` has been renamed
1378 * The `git_merge_file_options` structure member `flags` is now
1379 an unsigned int. It was previously a `git_merge_file_flags_t`.
1381 * `GIT_CHECKOUT_SAFE_CREATE` has been removed. Most users will generally
1382 be able to switch to `GIT_CHECKOUT_SAFE`, but if you require missing
1383 file handling during checkout, you may now use `GIT_CHECKOUT_SAFE |
1384 GIT_CHECKOUT_RECREATE_MISSING`.
1386 * The `git_clone_options` and `git_submodule_update_options`
1387 structures no longer have a `signature` field.
1389 * The following functions have removed the signature and/or log message
1390 parameters in favour of git-emulating ones.
1392 * `git_branch_create()`, `git_branch_move()`
1393 * `git_rebase_init()`, `git_rebase_abort()`
1394 * `git_reference_symbolic_create_matching()`,
1395 `git_reference_symbolic_create()`, `git_reference_create()`,
1396 `git_reference_create_matching()`,
1397 `git_reference_symbolic_set_target()`,
1398 `git_reference_set_target()`, `git_reference_rename()`
1399 * `git_remote_update_tips()`, `git_remote_fetch()`, `git_remote_push()`
1400 * `git_repository_set_head()`,
1401 `git_repository_set_head_detached()`,
1402 `git_repository_detach_head()`
1405 * `git_config_get_entry()` now gives back a ref-counted
1406 `git_config_entry`. You must free it when you no longer need it.
1408 * `git_config_get_string()` will return an error if used on a
1409 non-snapshot configuration, as there can be no guarantee that the
1410 returned pointer is valid.
1412 * `git_note_default_ref()` now uses a `git_buf` to return the string,
1413 as the string is otherwise not guaranteed to stay allocated.
1415 * `git_rebase_operation_current()` will return `GIT_REBASE_NO_OPERATION`
1416 if it is called immediately after creating a rebase session but before
1417 you have applied the first patch.
1419 * `git_rebase_options` now contains a `git_checkout_options` struct
1420 that will be used for functions that modify the working directory,
1421 namely `git_rebase_init`, `git_rebase_next` and
1422 `git_rebase_abort`. As a result, `git_rebase_open` now also takes
1423 a `git_rebase_options` and only the `git_rebase_init` and
1424 `git_rebase_open` functions take a `git_rebase_options`, where they
1425 will persist the options to subsequent `git_rebase` calls.
1427 * The `git_clone_options` struct now has fetch options in a
1428 `fetch_opts` field instead of remote callbacks in
1431 * The remote callbacks has gained a new member `push_negotiation`
1432 which gets called before sending the update commands to the server.
1434 * The following functions no longer act on a remote instance but
1435 change the repository's configuration. Their signatures have changed
1438 * `git_remote_set_url()`, `git_remote_seturl()`
1439 * `git_remote_add_fetch()`, `git_remote_add_push()` and
1440 * `git_remote_set_autotag()`
1442 * `git_remote_connect()` and `git_remote_prune()` now take a pointer
1445 * `git_remote_fetch()` and `git_remote_download()` now take a pointer
1446 to fetch options which determine the runtime configuration.
1448 * The `git_remote_autotag_option_t` values have been changed. It has
1449 gained a `_UNSPECIFIED` default value to specify no override for the
1452 * `git_remote_update_tips()` now takes a pointer to the callbacks as
1453 well as a boolean whether to write `FETCH_HEAD` and the autotag
1456 * `git_remote_create_anonymous()` no longer takes a fetch refspec as
1457 url-only remotes cannot have configured refspecs.
1459 * The `git_submodule_update_options` struct now has fetch options in
1460 the `fetch_opts` field instead of callbacks in the
1461 `remote_callbacks` field.
1463 * The following functions no longer act on a submodule instance but
1464 change the repository's configuration. Their signatures have changed
1467 * `git_submodule_set_url()`, `git_submodule_set_ignore()`,
1468 `git_submodule_set_update()`,
1469 `git_submodule_set_fetch_recurse_submodules()`.
1471 * `git_submodule_status()` no longer takes a submodule instance but a
1472 repsitory, a submodule name and an ignore setting.
1474 * The `push` function in the `git_transport` interface now takes a
1475 pointer to the remote callbacks.
1477 * The `git_index_entry` struct's fields' types have been changed to
1478 more accurately reflect what is in fact stored in the
1479 index. Specifically, time and file size are 32 bits intead of 64, as
1480 these values are truncated.
1482 * `GIT_EMERGECONFLICT` is now `GIT_ECONFLICT`, which more accurately
1483 describes the nature of the error.
1485 * It is no longer allowed to call `git_buf_grow()` on buffers
1486 borrowing the memory they point to.
1491 ### Changes or improvements
1493 * `git_signature_new()` now requires a non-empty email address.
1495 * Use CommonCrypto libraries for SHA-1 calculation on Mac OS X.
1497 * Disable SSL compression and SSLv2 and SSLv3 ciphers in favor of TLSv1
1500 * The fetch behavior of remotes with autotag set to `GIT_REMOTE_DOWNLOAD_TAGS_ALL`
1501 has been changed to match git 1.9.0 and later. In this mode, libgit2 now
1502 fetches all tags in addition to whatever else needs to be fetched.
1504 * `git_checkout()` now handles case-changing renames correctly on
1505 case-insensitive filesystems; for example renaming "readme" to "README".
1507 * The search for libssh2 is now done via pkg-config instead of a
1508 custom search of a few directories.
1510 * Add support for core.protectHFS and core.protectNTFS. Add more
1511 validation for filenames which we write such as references.
1513 * The local transport now generates textual progress output like
1514 git-upload-pack does ("counting objects").
1516 * `git_checkout_index()` can now check out an in-memory index that is not
1517 necessarily the repository's index, so you may check out an index
1518 that was produced by git_merge and friends while retaining the cached
1521 * Remove the default timeout for receiving / sending data over HTTP using
1522 the WinHTTP transport layer.
1524 * Add SPNEGO (Kerberos) authentication using GSSAPI on Unix systems.
1526 * Provide built-in objects for the empty blob (e69de29) and empty
1527 tree (4b825dc) objects.
1529 * The index' tree cache is now filled upon read-tree and write-tree
1530 and the cache is written to disk.
1532 * LF -> CRLF filter refuses to handle mixed-EOL files
1534 * LF -> CRLF filter now runs when * text = auto (with Git for Windows 1.9.4)
1536 * File unlocks are atomic again via rename. Read-only files on Windows are
1537 made read-write if necessary.
1539 * Share open packfiles across repositories to share descriptors and mmaps.
1541 * Use a map for the treebuilder, making insertion O(1)
1543 * The build system now accepts an option EMBED_SSH_PATH which when set
1544 tells it to include a copy of libssh2 at the given location. This is
1547 * Add support for refspecs with the asterisk in the middle of a
1550 * Fetching now performs opportunistic updates. To achieve this, we
1551 introduce a difference between active and passive refspecs, which
1552 make `git_remote_download()` and `git_remote_fetch()` to take a list of
1553 resfpecs to be the active list, similarly to how git fetch accepts a
1554 list on the command-line.
1556 * The THREADSAFE option to build libgit2 with threading support has
1557 been flipped to be on by default.
1559 * The remote object has learnt to prune remote-tracking branches. If
1560 the remote is configured to do so, this will happen via
1561 `git_remote_fetch()`. You can also call `git_remote_prune()` after
1562 connecting or fetching to perform the prune.
1567 * Introduce `git_buf_text_is_binary()` and `git_buf_text_contains_nul()` for
1568 consumers to perform binary detection on a git_buf.
1570 * `git_branch_upstream_remote()` has been introduced to provide the
1571 branch.<name>.remote configuration value.
1573 * Introduce `git_describe_commit()` and `git_describe_workdir()` to provide
1574 a description of the current commit (and working tree, respectively)
1575 based on the nearest tag or reference
1577 * Introduce `git_merge_bases()` and the `git_oidarray` type to expose all
1578 merge bases between two commits.
1580 * Introduce `git_merge_bases_many()` to expose all merge bases between
1583 * Introduce rebase functionality (using the merge algorithm only).
1584 Introduce `git_rebase_init()` to begin a new rebase session,
1585 `git_rebase_open()` to open an in-progress rebase session,
1586 `git_rebase_commit()` to commit the current rebase operation,
1587 `git_rebase_next()` to apply the next rebase operation,
1588 `git_rebase_abort()` to abort an in-progress rebase and `git_rebase_finish()`
1589 to complete a rebase operation.
1591 * Introduce `git_note_author()` and `git_note_committer()` to get the author
1592 and committer information on a `git_note`, respectively.
1594 * A factory function for ssh has been added which allows to change the
1595 path of the programs to execute for receive-pack and upload-pack on
1596 the server, `git_transport_ssh_with_paths()`.
1598 * The ssh transport supports asking the remote host for accepted
1599 credential types as well as multiple challeges using a single
1600 connection. This requires to know which username you want to connect
1601 as, so this introduces the USERNAME credential type which the ssh
1602 transport will use to ask for the username.
1604 * The `GIT_EPEEL` error code has been introduced when we cannot peel a tag
1605 to the requested object type; if the given object otherwise cannot be
1606 peeled, `GIT_EINVALIDSPEC` is returned.
1608 * Introduce `GIT_REPOSITORY_INIT_RELATIVE_GITLINK` to use relative paths
1609 when writing gitlinks, as is used by git core for submodules.
1611 * `git_remote_prune()` has been added. See above for description.
1614 * Introduce reference transactions, which allow multiple references to
1615 be locked at the same time and updates be queued. This also allows
1616 us to safely update a reflog with arbitrary contents, as we need to
1621 * `git_remote_supported_url()` and `git_remote_is_valid_url()` have been
1622 removed as they have become essentially useless with rsync-style ssh paths.
1624 * `git_clone_into()` and `git_clone_local_into()` have been removed from the
1625 public API in favour of `git_clone callbacks`.
1627 * The option to ignore certificate errors via `git_remote_cert_check()`
1628 is no longer present. Instead, `git_remote_callbacks` has gained a new
1629 entry which lets the user perform their own certificate checks.
1631 ### Breaking API changes
1633 * `git_cherry_pick()` is now `git_cherrypick()`.
1635 * The `git_submodule_update()` function was renamed to
1636 `git_submodule_update_strategy()`. `git_submodule_update()` is now used to
1637 provide functionalty similar to "git submodule update".
1639 * `git_treebuilder_create()` was renamed to `git_treebuilder_new()` to better
1640 reflect it being a constructor rather than something which writes to
1643 * `git_treebuilder_new()` (was `git_treebuilder_create()`) now takes a
1644 repository so that it can query repository configuration.
1645 Subsequently, `git_treebuilder_write()` no longer takes a repository.
1647 * `git_threads_init()` and `git_threads_shutdown()` have been renamed to
1648 `git_libgit2_init()` and `git_libgit2_shutdown()` to better explain what
1649 their purpose is, as it's grown to be more than just about threads.
1651 * `git_libgit2_init()` and `git_libgit2_shutdown()` now return the number of
1652 initializations of the library, so consumers may schedule work on the
1653 first initialization.
1655 * The `git_transport_register()` function no longer takes a priority and takes
1656 a URL scheme name (eg "http") instead of a prefix like "http://"
1658 * `git_index_name_entrycount()` and `git_index_reuc_entrycount()` now
1659 return size_t instead of unsigned int.
1661 * The `context_lines` and `interhunk_lines` fields in `git_diff`_options are
1662 now `uint32_t` instead of `uint16_t`. This allows to set them to `UINT_MAX`,
1663 in effect asking for "infinite" context e.g. to iterate over all the
1664 unmodified lines of a diff.
1666 * `git_status_file()` now takes an exact path. Use `git_status_list_new()` if
1667 pathspec searching is needed.
1669 * `git_note_create()` has changed the position of the notes reference
1670 name to match `git_note_remove()`.
1672 * Rename `git_remote_load()` to `git_remote_lookup()` to bring it in line
1673 with the rest of the lookup functions.
1675 * `git_remote_rename()` now takes the repository and the remote's
1676 current name. Accepting a remote indicates we want to change it,
1677 which we only did partially. It is much clearer if we accept a name
1678 and no loaded objects are changed.
1680 * `git_remote_delete()` now accepts the repository and the remote's name
1681 instead of a loaded remote.
1683 * `git_merge_head` is now `git_annotated_commit`, to better reflect its usage
1684 for multiple functions (including rebase)
1686 * The `git_clone_options` struct no longer provides the `ignore_cert_errors` or
1687 `remote_name` members for remote customization.
1689 Instead, the `git_clone_options` struct has two new members, `remote_cb` and
1690 `remote_cb_payload`, which allow the caller to completely override the remote
1691 creation process. If needed, the caller can use this callback to give their
1692 remote a name other than the default (origin) or disable cert checking.
1694 The `remote_callbacks` member has been preserved for convenience, although it
1695 is not used when a remote creation callback is supplied.
1697 * The `git_clone`_options struct now provides `repository_cb` and
1698 `repository_cb_payload` to allow the user to create a repository with
1701 * The `git_push` struct to perform a push has been replaced with
1702 `git_remote_upload()`. The refspecs and options are passed as a
1703 function argument. `git_push_update_tips()` is now also
1704 `git_remote_update_tips()` and the callbacks are in the same struct as
1707 * The `git_remote_set_transport()` function now sets a transport factory function,
1708 rather than a pre-existing transport instance.
1710 * The `git_transport` structure definition has moved into the sys/transport.h
1713 * libgit2 no longer automatically sets the OpenSSL locking
1714 functions. This is not something which we can know to do. A
1715 last-resort convenience function is provided in sys/openssl.h,
1716 `git_openssl_set_locking()` which can be used to set the locking.