4 This is a bugfix release with the following changes:
6 - Calculating information about renamed files during merges is more
7 efficient because dissimilarity about files is now being cached and
8 no longer needs to be recomputed.
10 - The `git_worktree_prune_init_options` has been correctly restored for
11 backward compatibility. In v1.0 it was incorrectly deprecated with a
14 - The optional ntlmclient dependency now supports NetBSD.
16 - A bug where attempting to stash on a bare repository may have failed
19 - Configuration files that are unreadable due to permissions are now
20 silently ignored, and treated as if they do not exist. This matches
21 git's behavior; previously this case would have been an error.
23 - v4 index files are now correctly written; previously we would read
24 them correctly but would not write the prefix-compression accurately,
27 - A bug where the smart HTTP transport could not read large data packets
28 has been fixed. Previously, fetching from servers like Gerrit, that
29 sent large data packets, would error.
34 This is release v1.0 "Luftschloss", which is the first stabe release of
35 libgit2. The API will stay compatible across all releases of the same major
36 version. This release includes bugfixes only and supersedes v0.99, which will
37 stop being maintained. Both v0.27 and v0.28 stay supported in accordance with
40 ### Changes or improvements
42 - CMake was converted to make use of the GNUInstallDirs module for both our
43 pkgconfig and install targets in favor of our custom build options
44 `BIN_INSTALL_DIR`, `LIB_INSTALL_DIR` and `INCLUDE_INSTALL_DIR`. Instead, you
45 can now use CMakes standard variables `CMAKE_INSTALL_BINDIR`,
46 `CMAKE_INSTALL_LIBDIR` and `CMAKE_INSTALL_INCLUDEDIR`.
48 - Some CMake build options accepted either a specific value or a boolean value
49 to disable the option altogether or use automatic detection. We only accepted
50 "ON" or "OFF", but none of the other values CMake recognizes as boolean. This
51 was aligned with CMake's understanding of booleans.
53 - The installed pkgconfig file contained incorrect values for both `libdir` and
54 `includedir` variables.
56 - If using pcre2 for regular expressions, then we incorrectly added "pcre2"
57 instead of "pcre2-8" to our pkgconfig dependencies, which was corrected.
59 - Fixed building the bundled ntlmclient dependency on FreeBSD, OpenBSD and
62 - When writing symlinks on Windows, we incorrectly handled relative symlink
63 targets, which was corrected.
65 - When using the HTTP protocol via macOS' SecureTransport implementation, reads
66 could stall at the end of the session and only continue after a timeout of 60
69 - The filesystem-based reference callback didn't corectly initialize the backend
72 - A segmentation fault was fixed when calling `git_blame_buffer()` for files
73 that were modified and added to the index.
75 - A backwards-incompatible change was introduced when we moved some structures
76 from "git2/credentials.h" into "git2/sys/credentials.h". This was fixed in the
77 case where you do not use hard deprecation.
79 - Improved error handling in various places.
85 This is v0.99 "Torschlusspanik". This will be the last minor release
86 before libgit2 v1.0. We expect to only respond to bugs in this release,
87 to stabilize it for next major release.
89 It contains significant refactorings, but is expected to be API-compatible
92 ### Changes or improvements
94 * When fetching from an anonymous remote using a URL with authentication
95 information provided in the URL (eg `https://foo:bar@example.com/repo`),
96 we would erroneously include the literal URL in the FETCH_HEAD file.
97 We now remove that to match git's behavior.
99 * Some credential structures, enums and values have been renamed:
100 `git_cred` is now `git_credential`. `git_credtype_t` is now
101 `git_credential_t`. Functions and types beginning with
102 `git_cred_` now begin with `git_credential`, and constants beginning
103 with `GIT_CREDTYPE` now begin with `GIT_CREDENTIAL`. The former names
106 * Several function signatures have been changed to return an `int` to
107 indicate error conditions. We encourage you to check them for errors
110 * `git_attr_cache_flush`
111 * `git_error_set_str`
112 * `git_index_name_clear`
113 * `git_index_reuc_clear`
114 * `git_libgit2_version`
115 * `git_mempack_reset`
122 * `git_remote_disconnect`
123 * `git_repository__cleanup`
124 * `git_repository_set_config`
125 * `git_repository_set_index`
126 * `git_repository_set_odb`
127 * `git_repository_set_refdb`
128 * `git_revwalk_reset`
129 * `git_revwalk_simplify_first_parent`
130 * `git_revwalk_sorting`
131 * `git_treebuilder_clear`
132 * `git_treebuilder_filter`
134 * The NTLM and Negotiate authentication mechanisms are now supported when
135 talking to git implementations hosted on Apache or nginx servers.
137 * The `HEAD` symbolic reference can no longer be deleted.
139 * `git_merge_driver_source_repo` no longer returns a `const git_repository *`,
140 it now returns a non-`const` `git_repository *`.
142 * Relative symbolic links are now supported on Windows when `core.symlinks`
145 * Servers that provide query parameters with a redirect are now supported.
147 * `git_submodule_sync` will now resolve relative URLs.
149 * When creating git endpoint URLs, double-slashes are no longer used when
150 the given git URL has a trailing slash.
152 * On Windows, a `DllMain` function is no longer included and thread-local
153 storage has moved to fiber-local storage in order to prevent race
154 conditions during shutdown.
156 * The tracing mechanism (`GIT_TRACE`) is now enabled by default and does
157 not need to be explicitly enabled in CMake.
159 * The size of Git objects is now represented by `git_object_size_t`
162 * Binary patches without data can now be parsed.
164 * A configuration snapshot can now be created from another configuration
165 snapshot, not just a "true" configuration object.
167 * The `git_commit_with_signature` API will now ensure that referenced
168 objects exist in the object database.
170 * Stash messages containing newlines will now be replaced with spaces;
171 they will no longer be (erroneously) written to the repository.
173 * `git_commit_create_with_signature` now verifies the commit information
174 to ensure that it points to a valid tree and valid parents.
176 * `git_apply` has an option `GIT_APPLY_CHECK` that will only do a dry-run.
177 The index and working directory will remain unmodified, and application
178 will report if it would have worked.
180 * Patches produced by Mercurial (those that lack some git extended headers)
181 can now be parsed and applied.
183 * Reference locks are obeyed correctly on POSIX platforms, instead of
186 * Patches with empty new files can now be read and applied.
188 * `git_apply_to_tree` can now correctly apply patches that add new files.
190 * The program data configuration on Windows (`C:\ProgramData\Git\config`)
191 must be owned by an administrator, a system account or the current user
194 * `git_blob_filtered_content` is now deprecated in favor of `git_blob_filter`.
196 * Configuration files can now be included conditionally using the
197 `onbranch` conditional.
199 * Checkout can now properly create and remove symbolic links to directories
202 * Stash no longer recomputes trees when committing a worktree, for
203 improved performance.
205 * Repository templates can now include a `HEAD` file to default the
206 initial default branch.
208 * Some configuration structures, enums and values have been renamed:
209 `git_cvar_map` is now `git_configmap`, `git_cvar_t` is now
210 `git_configmap_t`, `GIT_CVAR_FALSE` is now `GIT_CONFIGMAP_FALSE`,
211 `GIT_CVAR_TRUE` is now `GIT_CONFIGMAP_TRUE`, `GIT_CVAR_INT32` is now
212 `GIT_CONFIGMAP_INT32`, and `GIT_CVAR_STRING` is now `GIT_CONFIGMAP_STRING`.
213 The former names are deprecated.
215 * Repositories can now be created at the root of a Windows drive.
217 * Configuration lookups are now more efficiently cached.
219 * `git_commit_create_with_signature` now supports a `NULL` signature,
220 which will create a commit without adding a signature.
222 * When a repository lacks an `info` "common directory", we will no
223 longer erroneously return `GIT_ENOTFOUND` for all attribute lookups.
225 * Several attribute macros have been renamed: `GIT_ATTR_TRUE` is now
226 `GIT_ATTR_IS_TRUE`, `GIT_ATTR_FALSE` is now `GIT_ATTR_IS_FALSE`,
227 `GIT_ATTR_UNSPECIFIED` is now `GIT_ATTR_IS_UNSPECIFIED`. The
228 attribute enum `git_attr_t` is now `git_attr_value_t` and its
229 values have been renamed: `GIT_ATTR_UNSPECIFIED_T` is now
230 `GIT_ATTR_VALUE_UNSPECIFIED`, `GIT_ATTR_TRUE_T` is now
231 `GIT_ATTR_VALUE_TRUE`, `GIT_ATTR_FALSE_T` is now `GIT_ATTR_VALUE_FALSE`,
232 and `GIT_ATTR_VALUE_T` is now `GIT_ATTR_VALUE_STRING`. The
233 former names are deprecated.
235 * `git_object__size` is now `git_object_size`. The former name is
238 * `git_tag_create_frombuffer` is now `git_tag_create_from_buffer`. The
239 former name is deprecated.
241 * Several blob creation functions have been renamed:
242 `git_blob_create_frombuffer` is now named `git_blob_create_from_buffer`,
243 `git_blob_create_fromdisk` is now named `git_blob_create_from_disk`,
244 `git_blob_create_fromworkdir` is now named `git_blob_create_from_workdir`,
245 `git_blob_create_fromstream` is now named `git_blob_create_from_stream`,
246 and `git_blob_create_fromstream_commit` is now named
247 `git_blob_create_from_stream_commit`. The former names are deprecated.
249 * The function `git_oid_iszero` is now named `git_oid_is_zero`. The
250 former name is deprecated.
252 * Pattern matching is now done using `wildmatch` instead of `fnmatch`
253 for compatibility with git.
255 * The option initialization functions suffixed by `init_options` are now
256 suffixed with `options_init`. (For example, `git_checkout_init_options`
257 is now `git_checkout_options_init`.) The former names are deprecated.
259 * NTLM2 authentication is now supported on non-Windows platforms.
261 * The `git_cred_sign_callback` callback is now named `git_cred_sign_cb`.
262 The `git_cred_ssh_interactive_callback` callback is now named
263 `git_cred_ssh_interactive_cb`.
267 * honor escaped trailing whitespace.
268 * do not incorrectly negate sibling paths of a negated pattern.
269 * honor rules that stop ignoring files after a wildcard
271 * Attribute files now:
273 * honor leading and trailing whitespace.
274 * treat paths beginning with `\` as absolute only on Windows.
275 * properly handle escaped characters.
276 * stop reading macros defined in subdirectories
278 * The C locale is now correctly used when parsing regular expressions.
280 * The system PCRE2 or PCRE regular expression libraries are now used
281 when `regcomp_l` is not available on the system. If none of these
282 are available on the system, an included version of PCRE is used.
284 * Wildcards in reference specifications are now supported beyond simply
285 a bare wildcard (`*`) for compatibility with git.
287 * When `git_ignore_path_is_ignored` is provided a path with a trailing
288 slash (eg, `dir/`), it will now treat it as a directory for the
289 purposes of ignore matching.
291 * Patches that add or remove a file with a space in the path can now
294 * The `git_remote_completion_type` type is now `git_remote_completion_t`.
295 The former name is deprecated.
297 * The `git_odb_backend_malloc` is now `git_odb_backend_data_alloc`. The
298 former name is deprecated.
300 * The `git_transfer_progress_cb` callback is now `git_indexer_progress_cb`
301 and the `git_transfer_progress` structure is now `git_indexer_progress`.
302 The former names are deprecated.
304 * The example projects are now contained in a single `lg2` executable
307 * libgit2 now correctly handles more URLs, such as
308 `http://example.com:/repo.git` (colon but no port),
309 `http://example.com` (no path),
310 and `http://example.com:8080/` (path is /, nonstandard port).
312 * A carefully constructed commit object with a very large number
313 of parents may lead to potential out-of-bounds writes or
314 potential denial of service.
316 * The ProgramData configuration file is always read for compatibility
317 with Git for Windows and Portable Git installations. The ProgramData
318 location is not necessarily writable only by administrators, so we
319 now ensure that the configuration file is owned by the administrator
324 * The SSH host key now supports SHA-256 when `GIT_CERT_SSH_SHA256` is set.
326 * The diff format option `GIT_DIFF_FORMAT_PATCH_ID` can now be used to
327 emit an output like `git patch-id`.
329 * The `git_apply_options_init` function will initialize a
330 `git_apply_options` structure.
332 * The remote callbacks structure adds a `git_url_resolve_cb` callback
333 that is invoked when connecting to a server, so that applications
334 may edit or replace the URL before connection.
336 * The information about the original `HEAD` in a rebase operation is
337 available with `git_rebase_orig_head_name`. Its ID is available with
338 `git_rebase_orig_head_id`. The `onto` reference name is available with
339 `git_rebase_onto_name` and its ID is available with `git_rebase_onto_id`.
341 * ODB backends can now free backend data when an error occurs during its
342 backend data creation using `git_odb_backend_data_free`.
344 * Options may be specified to `git_repository_foreach_head` to control
345 its behavior: `GIT_REPOSITORY_FOREACH_HEAD_SKIP_REPO` will not skip
346 the main repository's HEAD reference, while
347 `GIT_REPOSITORY_FOREACH_HEAD_SKIP_WORKTREES` will now skip the
348 worktree HEAD references.
350 * The `GIT_OPT_DISABLE_PACK_KEEP_FILE_CHECKS` option can be specified to
351 `git_libgit2_opts()` to avoid looking for `.keep` files that correspond
352 to packfiles. This setting can improve performance when packfiles are
353 stored on high-latency filesystems like network filesystems.
355 * Blobs can now be filtered with `git_blob_filter`, which allows for
356 options to be set with `git_blob_filter_options`, including
357 `GIT_FILTER_NO_SYSTEM_ATTRIBUTES` to disable filtering with system-level
358 attributes in `/etc/gitattributes` and `GIT_ATTR_CHECK_INCLUDE_HEAD` to
359 enable filtering with `.gitattributes` files in the HEAD revision.
363 * The unused `git_headlist_cb` function declaration was removed.
365 * The unused `git_time_monotonic` API is removed.
367 * The erroneously exported `inttypes.h` header was removed.
371 - CVE-2019-1348: the fast-import stream command "feature
372 export-marks=path" allows writing to arbitrary file paths. As
373 libgit2 does not offer any interface for fast-import, it is not
374 susceptible to this vulnerability.
376 - CVE-2019-1349: by using NTFS 8.3 short names, backslashes or
377 alternate filesystreams, it is possible to cause submodules to
378 be written into pre-existing directories during a recursive
379 clone using git. As libgit2 rejects cloning into non-empty
380 directories by default, it is not susceptible to this
383 - CVE-2019-1350: recursive clones may lead to arbitrary remote
384 code executing due to improper quoting of command line
385 arguments. As libgit2 uses libssh2, which does not require us
386 to perform command line parsing, it is not susceptible to this
389 - CVE-2019-1351: Windows provides the ability to substitute
390 drive letters with arbitrary letters, including multi-byte
391 Unicode letters. To fix any potential issues arising from
392 interpreting such paths as relative paths, we have extended
393 detection of DOS drive prefixes to accomodate for such cases.
395 - CVE-2019-1352: by using NTFS-style alternative file streams for
396 the ".git" directory, it is possible to overwrite parts of the
397 repository. While this has been fixed in the past for Windows,
398 the same vulnerability may also exist on other systems that
399 write to NTFS filesystems. We now reject any paths starting
400 with ".git:" on all systems.
402 - CVE-2019-1353: by using NTFS-style 8.3 short names, it was
403 possible to write to the ".git" directory and thus overwrite
404 parts of the repository, leading to possible remote code
405 execution. While this problem was already fixed in the past for
406 Windows, other systems accessing NTFS filesystems are
407 vulnerable to this issue too. We now enable NTFS protecions by
408 default on all systems to fix this attack vector.
410 - CVE-2019-1354: on Windows, backslashes are not a valid part of
411 a filename but are instead interpreted as directory separators.
412 As other platforms allowed to use such paths, it was possible
413 to write such invalid entries into a Git repository and was
414 thus an attack vector to write into the ".git" dierctory. We
415 now reject any entries starting with ".git\" on all systems.
417 - CVE-2019-1387: it is possible to let a submodule's git
418 directory point into a sibling's submodule directory, which may
419 result in overwriting parts of the Git repository and thus lead
420 to arbitrary command execution. As libgit2 doesn't provide any
421 way to do submodule clones natively, it is not susceptible to
422 this vulnerability. Users of libgit2 that have implemented
423 recursive submodule clones manually are encouraged to review
424 their implementation for this vulnerability.
426 ### Breaking API changes
428 * The "private" implementation details of the `git_cred` structure have been
429 moved to a dedicated `git2/sys/cred.h` header, to clarify that the underlying
430 structures are only provided for custom transport implementers.
431 The breaking change is that the `username` member of the underlying struct
432 is now hidden, and a new `git_cred_get_username` function has been provided.
434 ### Breaking CMake configuration changes
436 * The CMake option to use a system http-parser library, instead of the
437 bundled dependency, has changed. This is due to a deficiency in
438 http-parser that we have fixed in our implementation. The bundled
439 library is now the default, but if you wish to force the use of the
440 system http-parser implementation despite incompatibilities, you can
441 specify `-DUSE_HTTP_PARSER=system` to CMake.
443 * The interactions between `USE_HTTPS` and `SHA1_BACKEND` have been
444 streamlined. The detection was moved to a new `USE_SHA1`, modeled after
445 `USE_HTTPS`, which takes the values "CollisionDetection/Backend/Generic", to
446 better match how the "hashing backend" is selected, the default (ON) being
447 "CollisionDetection". If you were using `SHA1_BACKEND` previously, you'll
448 need to check the value you've used, or switch to the autodetection.
452 The following individuals provided changes that were included in this
463 * Carlos MartÃn Nieto
471 * Dhruva Krishnamurthy
482 * Janardhan Pulivarthi
484 * Johannes Schindelin
486 * Josh Bleecher Snyder
510 ### Changes or improvements
512 * The library is now always built with cdecl calling conventions on
513 Windows; the ability to build a stdcall library has been removed.
515 * Reference log creation now honors `core.logallrefupdates=always`.
517 * Fix some issues with the error-reporting in the OpenSSL backend.
519 * HTTP proxy support is now builtin; libcurl is no longer used to support
520 proxies and is removed as a dependency.
522 * Certificate and credential callbacks can now return `GIT_PASSTHROUGH`
523 to decline to act; libgit2 will behave as if there was no callback set
526 * The line-ending filtering logic - when checking out files - has been
527 updated to match newer git (>= git 2.9) for proper interoperability.
529 * Symbolic links are now supported on Windows when `core.symlinks` is set
532 * Submodules with names which attempt to perform path traversal now have their
533 configuration ignored. Such names were blindly appended to the
534 `$GIT_DIR/modules` and a malicious name could lead to an attacker writing to
535 an arbitrary location. This matches git's handling of CVE-2018-11235.
537 * Object validation is now performed during tree creation in the
538 `git_index_write_tree_to` API.
540 * Configuration variable may now be specified on the same line as a section
541 header; previously this was erroneously a parser error.
543 * When an HTTP server supports both NTLM and Negotiate authentication
544 mechanisms, we would previously fail to authenticate with any mechanism.
546 * The `GIT_OPT_SET_PACK_MAX_OBJECTS` option can now set the maximum
547 number of objects allowed in a packfile being downloaded; this can help
548 limit the maximum memory used when fetching from an untrusted remote.
550 * Line numbers in diffs loaded from patch files were not being populated;
551 they are now included in the results.
553 * The repository's index is reloaded from disk at the beginning of
554 `git_merge` operations to ensure that it is up-to-date.
556 * Mailmap handling APIs have been introduced, and the new commit APIs
557 `git_commit_committer_with_mailmap` and `git_commit_author_with_mailmap`
558 will use the mailmap to resolve the committer and author information.
559 In addition, blame will use the mailmap given when the
560 `GIT_BLAME_USE_MAILMAP` option.
562 * Ignore handling for files in ignored folders would be ignored.
564 * Worktrees can now be backed by bare repositories.
566 * Trailing spaces are supported in `.gitignore` files, these spaces were
567 previously (and erroneously) treated as part of the pattern.
569 * The library can now be built with mbedTLS support for HTTPS.
571 * The diff status character 'T' will now be presented by the
572 `git_diff_status_char` API for diff entries that change type.
574 * Revision walks previously would sometimes include commits that should
575 have been ignored; this is corrected.
577 * Revision walks are now more efficient when the output is unsorted;
578 we now avoid walking all the way to the beginning of history unnecessarily.
580 * Error-handling around index extension loading has been fixed. We were
581 previously always misreporting a truncated index (#4858).
585 * The index may now be iterated atomically using `git_index_iterator`.
587 * Remote objects can now be created with extended options using the
588 `git_remote_create_with_opts` API.
590 * Diff objects can now be applied as changes to the working directory,
591 index or both, emulating the `git apply` command. Additionally,
592 `git_apply_to_tree` can apply those changes to a tree object as a
593 fully in-memory operation.
595 * You can now swap out memory allocators via the
596 `GIT_OPT_SET_ALLOCATOR` option with `git_libgit2_opts()`.
598 * You can now ensure that functions do not discard unwritten changes to the
599 index via the `GIT_OPT_ENABLE_UNSAVED_INDEX_SAFETY` option to
600 `git_libgit2_opts()`. This will cause functions that implicitly re-read
601 the index (eg, `git_checkout`) to fail if you have staged changes to the
602 index but you have not written the index to disk. (Unless the checkout
603 has the FORCE flag specified.)
605 At present, this defaults to off, but we intend to enable this more
606 broadly in the future, as a warning or error. We encourage you to
607 examine your code to ensure that you are not relying on the current
608 behavior that implicitly removes staged changes.
610 * Reference specifications can be parsed from an arbitrary string with
611 the `git_refspec_parse` API.
613 * You can now get the name and path of worktrees using the
614 `git_worktree_name` and `git_worktree_path` APIs, respectively.
616 * The `ref` field has been added to `git_worktree_add_options` to enable
617 the creation of a worktree from a pre-existing branch.
619 * It's now possible to analyze merge relationships between any two
620 references, not just against `HEAD`, using `git_merge_analysis_for_ref`.
624 * The `git_buf_free` API is deprecated; it has been renamed to
625 `git_buf_dispose` for consistency. The `git_buf_free` API will be
626 retained for backward compatibility for the foreseeable future.
628 * The `git_otype` enumeration and its members are deprecated and have
629 been renamed for consistency. The `GIT_OBJ_` enumeration values are
630 now prefixed with `GIT_OBJECT_`. The old enumerations and macros
631 will be retained for backward compatibility for the foreseeable future.
633 * Several index-related APIs have been renamed for consistency. The
634 `GIT_IDXENTRY_` enumeration values and macros have been renamed to
635 be prefixed with `GIT_INDEX_ENTRY_`. The `GIT_INDEXCAP` enumeration
636 values are now prefixed with `GIT_INDEX_CAPABILITY_`. The old
637 enumerations and macros will be retained for backward compatibility
638 for the foreseeable future.
640 * The error functions and enumeration values have been renamed for
641 consistency. The `giterr_` functions and values prefix have been
642 renamed to be prefixed with `git_error_`; similarly, the `GITERR_`
643 constants have been renamed to be prefixed with `GIT_ERROR_`.
644 The old enumerations and macros will be retained for backward
645 compatibility for the foreseeable future.
647 ### Breaking API changes
649 * The default checkout strategy changed from `DRY_RUN` to `SAFE` (#4531).
651 * Adding a symlink as .gitmodules into the index from the workdir or checking
652 out such files is not allowed as this can make a Git implementation write
653 outside of the repository and bypass the fsck checks for CVE-2018-11235.
658 ### Changes or improvements
660 * Improved `p_unlink` in `posix_w32.c` to try and make a file writable
661 before sleeping in the retry loop to prevent unnecessary calls to sleep.
663 * The CMake build infrastructure has been improved to speed up building time.
665 * A new CMake option "-DUSE_HTTPS=<backend>" makes it possible to explicitly
666 choose an HTTP backend.
668 * A new CMake option "-DSHA1_BACKEND=<backend>" makes it possible to explicitly
669 choose an SHA1 backend. The collision-detecting backend is now the default.
671 * A new CMake option "-DUSE_BUNDLED_ZLIB" makes it possible to explicitly use
672 the bundled zlib library.
674 * A new CMake option "-DENABLE_REPRODUCIBLE_BUILDS" makes it possible to
675 generate a reproducible static archive. This requires support from your
678 * The minimum required CMake version has been bumped to 2.8.11.
680 * Writing to a configuration file now preserves the case of the key given by the
681 caller for the case-insensitive portions of the key (existing sections are
682 used even if they don't match).
684 * We now support conditional includes in configuration files.
686 * Fix for handling re-reading of configuration files with includes.
688 * Fix for reading patches which contain exact renames only.
690 * Fix for reading patches with whitespace in the compared files' paths.
692 * We will now fill `FETCH_HEAD` from all passed refspecs instead of overwriting
695 * There is a new diff option, `GIT_DIFF_INDENT_HEURISTIC` which activates a
696 heuristic which takes into account whitespace and indentation in order to
697 produce better diffs when dealing with ambiguous diff hunks.
699 * Fix for pattern-based ignore rules where files ignored by a rule cannot be
700 un-ignored by another rule.
702 * Sockets opened by libgit2 are now being closed on exec(3) if the platform
705 * Fix for peeling annotated tags from packed-refs files.
707 * Fix reading huge loose objects from the object database.
709 * Fix files not being treated as modified when only the file mode has changed.
711 * We now explicitly reject adding submodules to the index via
712 `git_index_add_frombuffer`.
714 * Fix handling of `GIT_DIFF_FIND_RENAMES_FROM_REWRITES` raising `SIGABRT` when
715 one file has been deleted and another file has been rewritten.
717 * Fix for WinHTTP not properly handling NTLM and Negotiate challenges.
719 * When using SSH-based transports, we now repeatedly ask for the passphrase to
720 decrypt the private key in case a wrong passphrase is being provided.
722 * When generating conflict markers, they will now use the same line endings as
723 the rest of the file.
727 * The `git_merge_file_options` structure now contains a new setting,
728 `marker_size`. This allows users to set the size of markers that
729 delineate the sides of merged files in the output conflict file.
730 By default this is 7 (`GIT_MERGE_CONFLICT_MARKER_SIZE`), which
731 produces output markers like `<<<<<<<` and `>>>>>>>`.
733 * `git_remote_create_detached()` creates a remote that is not associated
734 to any repository (and does not apply configuration like 'insteadof' rules).
735 This is mostly useful for e.g. emulating `git ls-remote` behavior.
737 * `git_diff_patchid()` lets you generate patch IDs for diffs.
739 * `git_status_options` now has an additional field `baseline` to allow creating
740 status lists against different trees.
742 * New family of functions to allow creating notes for a specific notes commit
743 instead of for a notes reference.
745 * New family of functions to allow parsing message trailers. This API is still
746 experimental and may change in future releases.
750 ### Breaking API changes
752 * Signatures now distinguish between +0000 and -0000 UTC offsets.
754 * The certificate check callback in the WinHTTP transport will now receive the
755 `message_cb_payload` instead of the `cred_acquire_payload`.
757 * We are now reading symlinked directories under .git/refs.
759 * We now refuse creating branches named "HEAD".
761 * We now refuse reading and writing all-zero object IDs into the
764 * We now read the effective user's configuration file instead of the real user's
765 configuration in case libgit2 runs as part of a setuid binary.
767 * The `git_odb_open_rstream` function and its `readstream` callback in the
768 `git_odb_backend` interface have changed their signatures to allow providing
769 the object's size and type to the caller.
774 ### Changes or improvements
776 * Support for opening, creating and modifying worktrees.
778 * We can now detect SHA1 collisions resulting from the SHAttered attack. These
779 checks can be enabled at build time via `-DUSE_SHA1DC`.
781 * Fix for missing implementation of `git_merge_driver_source` getters.
783 * Fix for installed pkg-config file being broken when the prefix contains
786 * We now detect when the hashsum of on-disk objects does not match their
789 * We now support open-ended ranges (e.g. "master..", "...master") in our
790 revision range parsing code.
792 * We now correctly compute ignores with leading "/" in subdirectories.
794 * We now optionally call `fsync` on loose objects, packfiles and their indexes,
795 loose references and packed reference files.
797 * We can now build against OpenSSL v1.1 and against LibreSSL.
799 * `GIT_MERGE_OPTIONS_INIT` now includes a setting to perform rename detection.
800 This aligns this structure with the default by `git_merge` and
801 `git_merge_trees` when `NULL` was provided for the options.
803 * Improvements for reading index v4 files.
805 * Perform additional retries for filesystem operations on Windows when files
806 are temporarily locked by other processes.
810 * New family of functions to handle worktrees:
812 * `git_worktree_list()` lets you look up worktrees for a repository.
813 * `git_worktree_lookup()` lets you get a specific worktree.
814 * `git_worktree_open_from_repository()` lets you get the associated worktree
817 * `git_worktree_add` lets you create new worktrees.
818 * `git_worktree_prune` lets you remove worktrees from disk.
819 * `git_worktree_lock()` and `git_worktree_unlock()` let you lock
820 respectively unlock a worktree.
821 * `git_repository_open_from_worktree()` lets you open a repository via
822 * `git_repository_head_for_worktree()` lets you get the current `HEAD` for a
824 * `git_repository_head_detached_for_worktree()` lets you check whether a
825 linked worktree is in detached HEAD mode.
827 * `git_repository_item_path()` lets you retrieve paths for various repository
830 * `git_repository_commondir()` lets you retrieve the common directory of a
833 * `git_branch_is_checked_out()` allows you to check whether a branch is checked
834 out in a repository or any of its worktrees.
836 * `git_repository_submodule_cache_all()` and
837 `git_repository_submodule_cache_clear()` functions allow you to prime or clear
838 the submodule cache of a repository.
840 * You can disable strict hash verifications via the
841 `GIT_OPT_ENABLE_STRICT_HASH_VERIFICATION` option with `git_libgit2_opts()`.
843 * You can enable us calling `fsync` for various files inside the ".git"
844 directory by setting the `GIT_OPT_ENABLE_FSYNC_GITDIR` option with
845 `git_libgit2_opts()`.
847 * You can now enable "offset deltas" when creating packfiles and negotiating
848 packfiles with a remote server by setting `GIT_OPT_ENABLE_OFS_DELTA` option
849 with `GIT_libgit2_opts()`.
851 * You can now set the default share mode on Windows for opening files using
852 `GIT_OPT_SET_WINDOWS_SHAREMODE` option with `git_libgit2_opts()`.
853 You can query the current share mode with `GIT_OPT_GET_WINDOWS_SHAREMODE`.
855 * `git_transport_smart_proxy_options()' enables you to get the proxy options for
858 * The `GIT_FILTER_INIT` macro and the `git_filter_init` function are provided
859 to initialize a `git_filter` structure.
861 ### Breaking API changes
863 * `clone_checkout_strategy` has been removed from
864 `git_submodule_update_option`. The checkout strategy used to clone will
865 be the same strategy specified in `checkout_opts`.
870 ### Changes or improvements
872 * Fix repository discovery with `git_repository_discover` and
873 `git_repository_open_ext` to match git's handling of a ceiling
874 directory at the current directory. git only checks ceiling
875 directories when its search ascends to a parent directory. A ceiling
876 directory matching the starting directory will not prevent git from
877 finding a repository in the starting directory or a parent directory.
879 * Do not fail when deleting remotes in the presence of broken
880 global configs which contain branches.
882 * Support for reading and writing git index v4 files
884 * Improve the performance of the revwalk and bring us closer to git's code.
886 * The reference db has improved support for concurrency and returns `GIT_ELOCKED`
887 when an operation could not be performed due to locking.
889 * Nanosecond resolution is now activated by default, following git's change to
892 * We now restrict the set of ciphers we let OpenSSL use by default.
894 * Users can now register their own merge drivers for use with `.gitattributes`.
895 The library also gained built-in support for the union merge driver.
897 * The default for creating references is now to validate that the object does
900 * Add `git_proxy_options` which is used by the different networking
901 implementations to let the caller specify the proxy settings instead of
902 relying on the environment variables.
906 * You can now get the user-agent used by libgit2 using the
907 `GIT_OPT_GET_USER_AGENT` option with `git_libgit2_opts()`.
908 It is the counterpart to `GIT_OPT_SET_USER_AGENT`.
910 * The `GIT_OPT_SET_SSL_CIPHERS` option for `git_libgit2_opts()` lets you specify
911 a custom list of ciphers to use for OpenSSL.
913 * `git_commit_create_buffer()` creates a commit and writes it into a
914 user-provided buffer instead of writing it into the object db. Combine it with
915 `git_commit_create_with_signature()` in order to create a commit with a
916 cryptographic signature.
918 * `git_blob_create_fromstream()` and
919 `git_blob_create_fromstream_commit()` allow you to create a blob by
920 writing into a stream. Useful when you do not know the final size or
921 want to copy the contents from another stream.
923 * New flags for `git_repository_open_ext`:
925 * `GIT_REPOSITORY_OPEN_NO_DOTGIT` - Do not check for a repository by
926 appending `/.git` to the `start_path`; only open the repository if
927 `start_path` itself points to the git directory.
928 * `GIT_REPOSITORY_OPEN_FROM_ENV` - Find and open a git repository,
929 respecting the environment variables used by the git command-line
930 tools. If set, `git_repository_open_ext` will ignore the other
931 flags and the `ceiling_dirs` argument, and will allow a NULL
932 `path` to use `GIT_DIR` or search from the current directory. The
933 search for a repository will respect `$GIT_CEILING_DIRECTORIES`
934 and `$GIT_DISCOVERY_ACROSS_FILESYSTEM`. The opened repository
935 will respect `$GIT_INDEX_FILE`, `$GIT_NAMESPACE`,
936 `$GIT_OBJECT_DIRECTORY`, and `$GIT_ALTERNATE_OBJECT_DIRECTORIES`.
937 In the future, this flag will also cause `git_repository_open_ext`
938 to respect `$GIT_WORK_TREE` and `$GIT_COMMON_DIR`; currently,
939 `git_repository_open_ext` with this flag will error out if either
940 `$GIT_WORK_TREE` or `$GIT_COMMON_DIR` is set.
942 * `git_diff_from_buffer()` can create a `git_diff` object from the contents
943 of a git-style patch file.
945 * `git_index_version()` and `git_index_set_version()` to get and set
948 * `git_odb_expand_ids()` lets you check for the existence of multiple
951 * The new `git_blob_dup()`, `git_commit_dup()`, `git_tag_dup()` and
952 `git_tree_dup()` functions provide type-specific wrappers for
953 `git_object_dup()` to reduce noise and increase type safety for callers.
955 * `git_reference_dup()` lets you duplicate a reference to aid in ownership
956 management and cleanup.
958 * `git_signature_from_buffer()` lets you create a signature from a string in the
959 format that appear in objects.
961 * `git_tree_create_updated()` lets you create a tree based on another one
962 together with a list of updates. For the covered update cases, it's more
963 efficient than the `git_index` route.
965 * `git_apply_patch()` applies hunks from a `git_patch` to a buffer.
967 * `git_diff_to_buf()` lets you print an entire diff directory to a buffer,
968 similar to how `git_patch_to_buf()` works.
970 * `git_proxy_init_options()` is added to initialize a `git_proxy_options`
971 structure at run-time.
973 * `git_merge_driver_register()`, `git_merge_driver_unregister()` let you
974 register and unregister a custom merge driver to be used when `.gitattributes`
977 * `git_merge_driver_lookup()` can be used to look up a merge driver by name.
979 * `git_merge_driver_source_repo()`, `git_merge_driver_source_ancestor()`,
980 `git_merge_driver_source_ours()`, `git_merge_driver_source_theirs()`,
981 `git_merge_driver_source_file_options()` added as accessors to
982 `git_merge_driver_source`.
986 * `git_blob_create_fromchunks()` has been removed in favour of
987 `git_blob_create_fromstream()`.
989 ### Breaking API changes
991 * `git_packbuilder_object_count` and `git_packbuilder_written` now
992 return a `size_t` instead of a `uint32_t` for more thorough
993 compatibility with the rest of the library.
995 * `git_packbuiler_progress` now provides explicitly sized `uint32_t`
996 values instead of `unsigned int`.
998 * `git_diff_file` now includes an `id_abbrev` field that reflects the
999 number of nibbles set in the `id` field.
1001 * `git_odb_backend` now has a `freshen` function pointer. This optional
1002 function pointer is similar to the `exists` function, but it will update
1003 a last-used marker. For filesystem-based object databases, this updates
1004 the timestamp of the file containing the object, to indicate "freshness".
1005 If this is `NULL`, then it will not be called and the `exists` function
1006 will be used instead.
1008 * `git_remote_connect()` now accepts `git_proxy_options` argument, and
1009 `git_fetch_options` and `git_push_options` each have a `proxy_opts` field.
1011 * `git_merge_options` now provides a `default_driver` that can be used
1012 to provide the name of a merge driver to be used to handle files changed
1018 ### Changes or improvements
1020 * Custom merge drivers can now be registered, which allows callers to
1021 configure callbacks to honor `merge=driver` configuration in
1024 * Custom filters can now be registered with wildcard attributes, for
1025 example `filter=*`. Consumers should examine the attributes parameter
1026 of the `check` function for details.
1028 * Symlinks are now followed when locking a file, which can be
1029 necessary when multiple worktrees share a base repository.
1031 * You can now set your own user-agent to be sent for HTTP requests by
1032 using the `GIT_OPT_SET_USER_AGENT` with `git_libgit2_opts()`.
1034 * You can set custom HTTP header fields to be sent along with requests
1035 by passing them in the fetch and push options.
1037 * Tree objects are now assumed to be sorted. If a tree is not
1038 correctly formed, it will give bad results. This is the git approach
1039 and cuts a significant amount of time when reading the trees.
1041 * Filter registration is now protected against concurrent
1044 * Filenames which are not valid on Windows in an index no longer cause
1045 to fail to parse it on that OS.
1047 * Rebases can now be performed purely in-memory, without touching the
1048 repository's workdir.
1050 * When adding objects to the index, or when creating new tree or commit
1051 objects, the inputs are validated to ensure that the dependent objects
1052 exist and are of the correct type. This object validation can be
1053 disabled with the GIT_OPT_ENABLE_STRICT_OBJECT_CREATION option.
1055 * The WinHTTP transport's handling of bad credentials now behaves like
1056 the others, asking for credentials again.
1060 * `git_config_lock()` has been added, which allow for
1061 transactional/atomic complex updates to the configuration, removing
1062 the opportunity for concurrent operations and not committing any
1063 changes until the unlock.
1065 * `git_diff_options` added a new callback `progress_cb` to report on the
1066 progress of the diff as files are being compared. The documentation of
1067 the existing callback `notify_cb` was updated to reflect that it only
1068 gets called when new deltas are added to the diff.
1070 * `git_fetch_options` and `git_push_options` have gained a `custom_headers`
1071 field to set the extra HTTP header fields to send.
1073 * `git_stream_register_tls()` lets you register a callback to be used
1074 as the constructor for a TLS stream instead of the libgit2 built-in
1077 * `git_commit_header_field()` allows you to look up a specific header
1080 * `git_commit_extract_signature()` extracts the signature from a
1081 commit and gives you both the signature and the signed data so you
1086 * No APIs were removed in this version.
1088 ### Breaking API changes
1090 * The `git_merge_tree_flag_t` is now `git_merge_flag_t`. Subsequently,
1091 its members are no longer prefixed with `GIT_MERGE_TREE_FLAG` but are
1092 now prefixed with `GIT_MERGE_FLAG`, and the `tree_flags` field of the
1093 `git_merge_options` structure is now named `flags`.
1095 * The `git_merge_file_flags_t` enum is now `git_merge_file_flag_t` for
1096 consistency with other enum type names.
1098 * `git_cert` descendent types now have a proper `parent` member
1100 * It is the responsibility of the refdb backend to decide what to do
1101 with the reflog on ref deletion. The file-based backend must delete
1102 it, a database-backed one may wish to archive it.
1104 * `git_config_backend` has gained two entries. `lock` and `unlock`
1105 with which to implement the transactional/atomic semantics for the
1106 configuration backend.
1108 * `git_index_add` and `git_index_conflict_add()` will now use the case
1109 as provided by the caller on case insensitive systems. Previous
1110 versions would keep the case as it existed in the index. This does
1111 not affect the higher-level `git_index_add_bypath` or
1112 `git_index_add_frombuffer` functions.
1114 * The `notify_payload` field of `git_diff_options` was renamed to `payload`
1115 to reflect that it's also the payload for the new progress callback.
1117 * The `git_config_level_t` enum has gained a higher-priority value
1118 `GIT_CONFIG_LEVEL_PROGRAMDATA` which represent a rough Windows equivalent
1119 to the system level configuration.
1121 * `git_rebase_options` now has a `merge_options` field.
1123 * The index no longer performs locking itself. This is not something
1124 users of the library should have been relying on as it's not part of
1125 the concurrency guarantees.
1127 * `git_remote_connect()` now takes a `custom_headers` argument to set
1128 the extra HTTP header fields to send.
1133 ### Changes or improvements
1135 * Patience and minimal diff drivers can now be used for merges.
1137 * Merges can now ignore whitespace changes.
1139 * Updated binary identification in CRLF filtering to avoid false positives in
1142 * Rename and copy detection is enabled for small files.
1144 * Checkout can now handle an initial checkout of a repository, making
1145 `GIT_CHECKOUT_SAFE_CREATE` unnecessary for users of clone.
1147 * The signature parameter in the ref-modifying functions has been
1148 removed. Use `git_repository_set_ident()` and
1149 `git_repository_ident()` to override the signature to be used.
1151 * The local transport now auto-scales the number of threads to use
1152 when creating the packfile instead of sticking to one.
1154 * Reference renaming now uses the right id for the old value.
1156 * The annotated version of branch creation, HEAD detaching and reset
1157 allow for specifying the expression from the user to be put into the
1160 * `git_rebase_commit` now returns `GIT_EUNMERGED` when you attempt to
1161 commit with unstaged changes.
1163 * On Mac OS X, we now use SecureTransport to provide the cryptographic
1164 support for HTTPS connections insead of OpenSSL.
1166 * Checkout can now accept an index for the baseline computations via the
1167 `baseline_index` member.
1169 * The configuration for fetching is no longer stored inside the
1170 `git_remote` struct but has been moved to a `git_fetch_options`. The
1171 remote functions now take these options or the callbacks instead of
1172 setting them beforehand.
1174 * `git_submodule` instances are no longer cached or shared across
1175 lookup. Each submodule represents the configuration at the time of
1178 * The index now uses diffs for `add_all()` and `update_all()` which
1179 gives it a speed boost and closer semantics to git.
1181 * The ssh transport now reports the stderr output from the server as
1182 the error message, which allows you to get the "repository not
1185 * `git_index_conflict_add()` will remove staged entries that exist for
1188 * The flags for a `git_diff_file` will now have the `GIT_DIFF_FLAG_EXISTS`
1189 bit set when a file exists on that side of the diff. This is useful
1190 for understanding whether a side of the diff exists in the presence of
1193 * The constructor for a write-stream into the odb now takes
1194 `git_off_t` instead of `size_t` for the size of the blob, which
1195 allows putting large files into the odb on 32-bit systems.
1197 * The remote's push and pull URLs now honor the url.$URL.insteadOf
1198 configuration. This allows modifying URL prefixes to a custom
1199 value via gitconfig.
1201 * `git_diff_foreach`, `git_diff_blobs`, `git_diff_blob_to_buffer`,
1202 and `git_diff_buffers` now accept a new binary callback of type
1203 `git_diff_binary_cb` that includes the binary diff information.
1205 * The race condition mitigations described in `racy-git.txt` have been
1208 * If libcurl is installed, we will use it to connect to HTTP(S)
1213 * The `git_merge_options` gained a `file_flags` member.
1215 * Parsing and retrieving a configuration value as a path is exposed
1216 via `git_config_parse_path()` and `git_config_get_path()`
1219 * `git_repository_set_ident()` and `git_repository_ident()` serve to
1220 set and query which identity will be used when writing to the
1223 * `git_config_entry_free()` frees a config entry.
1225 * `git_config_get_string_buf()` provides a way to safely retrieve a
1226 string from a non-snapshot configuration.
1228 * `git_annotated_commit_from_revspec()` allows to get an annotated
1229 commit from an extended sha synatx string.
1231 * `git_repository_set_head_detached_from_annotated()`,
1232 `git_branch_create_from_annotated()` and
1233 `git_reset_from_annotated()` allow for the caller to provide an
1234 annotated commit through which they can control what expression is
1235 put into the reflog as the source/target.
1237 * `git_index_add_frombuffer()` can now create a blob from memory
1238 buffer and add it to the index which is attached to a repository.
1240 * The structure `git_fetch_options` has been added to determine the
1241 runtime configuration for fetching, such as callbacks, pruning and
1242 autotag behaviour. It has the runtime initializer
1243 `git_fetch_init_options()`.
1245 * The enum `git_fetch_prune_t` has been added, letting you specify the
1246 pruning behaviour for a fetch.
1248 * A push operation will notify the caller of what updates it indends
1249 to perform on the remote, which provides similar information to
1250 git's pre-push hook.
1252 * `git_stash_apply()` can now apply a stashed state from the stash list,
1253 placing the data into the working directory and index.
1255 * `git_stash_pop()` will apply a stashed state (like `git_stash_apply()`)
1256 but will remove the stashed state after a successful application.
1258 * A new error code `GIT_EEOF` indicates an early EOF from the
1259 server. This typically indicates an error with the URL or
1260 configuration of the server, and tools can use this to show messages
1261 about failing to communicate with the server.
1263 * A new error code `GIT_EINVALID` indicates that an argument to a
1264 function is invalid, or an invalid operation was requested.
1266 * `git_diff_index_to_workdir()` and `git_diff_tree_to_index()` will now
1267 produce deltas of type `GIT_DELTA_CONFLICTED` to indicate that the index
1268 side of the delta is a conflict.
1270 * The `git_status` family of functions will now produce status of type
1271 `GIT_STATUS_CONFLICTED` to indicate that a conflict exists for that file
1274 * `git_index_entry_is_conflict()` is a utility function to determine if
1275 a given index entry has a non-zero stage entry, indicating that it is
1276 one side of a conflict.
1278 * It is now possible to pass a keypair via a buffer instead of a
1279 path. For this, `GIT_CREDTYPE_SSH_MEMORY` and
1280 `git_cred_ssh_key_memory_new()` have been added.
1282 * `git_filter_list_contains` will indicate whether a particular
1283 filter will be run in the given filter list.
1285 * `git_commit_header_field()` has been added, which allows retrieving
1286 the contents of an arbitrary header field.
1288 * `git_submodule_set_branch()` allows to set the configured branch for
1293 * `git_remote_save()` and `git_remote_clear_refspecs()` have been
1294 removed. Remote's configuration is changed via the configuration
1295 directly or through a convenience function which performs changes to
1296 the configuration directly.
1298 * `git_remote_set_callbacks()`, `git_remote_get_callbacks()` and
1299 `git_remote_set_transport()` have been removed and the remote no
1300 longer stores this configuration.
1302 * `git_remote_set_fetch_refpecs()` and
1303 `git_remote_set_push_refspecs()` have been removed. There is no
1304 longer a way to set the base refspecs at run-time.
1306 * `git_submodule_save()` has been removed. The submodules are no
1307 longer configured via the objects.
1309 * `git_submodule_reload_all()` has been removed as we no longer cache
1312 ### Breaking API changes
1314 * `git_smart_subtransport_cb` now has a `param` parameter.
1316 * The `git_merge_options` structure member `flags` has been renamed
1319 * The `git_merge_file_options` structure member `flags` is now
1320 an unsigned int. It was previously a `git_merge_file_flags_t`.
1322 * `GIT_CHECKOUT_SAFE_CREATE` has been removed. Most users will generally
1323 be able to switch to `GIT_CHECKOUT_SAFE`, but if you require missing
1324 file handling during checkout, you may now use `GIT_CHECKOUT_SAFE |
1325 GIT_CHECKOUT_RECREATE_MISSING`.
1327 * The `git_clone_options` and `git_submodule_update_options`
1328 structures no longer have a `signature` field.
1330 * The following functions have removed the signature and/or log message
1331 parameters in favour of git-emulating ones.
1333 * `git_branch_create()`, `git_branch_move()`
1334 * `git_rebase_init()`, `git_rebase_abort()`
1335 * `git_reference_symbolic_create_matching()`,
1336 `git_reference_symbolic_create()`, `git_reference_create()`,
1337 `git_reference_create_matching()`,
1338 `git_reference_symbolic_set_target()`,
1339 `git_reference_set_target()`, `git_reference_rename()`
1340 * `git_remote_update_tips()`, `git_remote_fetch()`, `git_remote_push()`
1341 * `git_repository_set_head()`,
1342 `git_repository_set_head_detached()`,
1343 `git_repository_detach_head()`
1346 * `git_config_get_entry()` now gives back a ref-counted
1347 `git_config_entry`. You must free it when you no longer need it.
1349 * `git_config_get_string()` will return an error if used on a
1350 non-snapshot configuration, as there can be no guarantee that the
1351 returned pointer is valid.
1353 * `git_note_default_ref()` now uses a `git_buf` to return the string,
1354 as the string is otherwise not guaranteed to stay allocated.
1356 * `git_rebase_operation_current()` will return `GIT_REBASE_NO_OPERATION`
1357 if it is called immediately after creating a rebase session but before
1358 you have applied the first patch.
1360 * `git_rebase_options` now contains a `git_checkout_options` struct
1361 that will be used for functions that modify the working directory,
1362 namely `git_rebase_init`, `git_rebase_next` and
1363 `git_rebase_abort`. As a result, `git_rebase_open` now also takes
1364 a `git_rebase_options` and only the `git_rebase_init` and
1365 `git_rebase_open` functions take a `git_rebase_options`, where they
1366 will persist the options to subsequent `git_rebase` calls.
1368 * The `git_clone_options` struct now has fetch options in a
1369 `fetch_opts` field instead of remote callbacks in
1372 * The remote callbacks has gained a new member `push_negotiation`
1373 which gets called before sending the update commands to the server.
1375 * The following functions no longer act on a remote instance but
1376 change the repository's configuration. Their signatures have changed
1379 * `git_remote_set_url()`, `git_remote_seturl()`
1380 * `git_remote_add_fetch()`, `git_remote_add_push()` and
1381 * `git_remote_set_autotag()`
1383 * `git_remote_connect()` and `git_remote_prune()` now take a pointer
1386 * `git_remote_fetch()` and `git_remote_download()` now take a pointer
1387 to fetch options which determine the runtime configuration.
1389 * The `git_remote_autotag_option_t` values have been changed. It has
1390 gained a `_UNSPECIFIED` default value to specify no override for the
1393 * `git_remote_update_tips()` now takes a pointer to the callbacks as
1394 well as a boolean whether to write `FETCH_HEAD` and the autotag
1397 * `git_remote_create_anonymous()` no longer takes a fetch refspec as
1398 url-only remotes cannot have configured refspecs.
1400 * The `git_submodule_update_options` struct now has fetch options in
1401 the `fetch_opts` field instead of callbacks in the
1402 `remote_callbacks` field.
1404 * The following functions no longer act on a submodule instance but
1405 change the repository's configuration. Their signatures have changed
1408 * `git_submodule_set_url()`, `git_submodule_set_ignore()`,
1409 `git_submodule_set_update()`,
1410 `git_submodule_set_fetch_recurse_submodules()`.
1412 * `git_submodule_status()` no longer takes a submodule instance but a
1413 repsitory, a submodule name and an ignore setting.
1415 * The `push` function in the `git_transport` interface now takes a
1416 pointer to the remote callbacks.
1418 * The `git_index_entry` struct's fields' types have been changed to
1419 more accurately reflect what is in fact stored in the
1420 index. Specifically, time and file size are 32 bits intead of 64, as
1421 these values are truncated.
1423 * `GIT_EMERGECONFLICT` is now `GIT_ECONFLICT`, which more accurately
1424 describes the nature of the error.
1426 * It is no longer allowed to call `git_buf_grow()` on buffers
1427 borrowing the memory they point to.
1432 ### Changes or improvements
1434 * `git_signature_new()` now requires a non-empty email address.
1436 * Use CommonCrypto libraries for SHA-1 calculation on Mac OS X.
1438 * Disable SSL compression and SSLv2 and SSLv3 ciphers in favor of TLSv1
1441 * The fetch behavior of remotes with autotag set to `GIT_REMOTE_DOWNLOAD_TAGS_ALL`
1442 has been changed to match git 1.9.0 and later. In this mode, libgit2 now
1443 fetches all tags in addition to whatever else needs to be fetched.
1445 * `git_checkout()` now handles case-changing renames correctly on
1446 case-insensitive filesystems; for example renaming "readme" to "README".
1448 * The search for libssh2 is now done via pkg-config instead of a
1449 custom search of a few directories.
1451 * Add support for core.protectHFS and core.protectNTFS. Add more
1452 validation for filenames which we write such as references.
1454 * The local transport now generates textual progress output like
1455 git-upload-pack does ("counting objects").
1457 * `git_checkout_index()` can now check out an in-memory index that is not
1458 necessarily the repository's index, so you may check out an index
1459 that was produced by git_merge and friends while retaining the cached
1462 * Remove the default timeout for receiving / sending data over HTTP using
1463 the WinHTTP transport layer.
1465 * Add SPNEGO (Kerberos) authentication using GSSAPI on Unix systems.
1467 * Provide built-in objects for the empty blob (e69de29) and empty
1468 tree (4b825dc) objects.
1470 * The index' tree cache is now filled upon read-tree and write-tree
1471 and the cache is written to disk.
1473 * LF -> CRLF filter refuses to handle mixed-EOL files
1475 * LF -> CRLF filter now runs when * text = auto (with Git for Windows 1.9.4)
1477 * File unlocks are atomic again via rename. Read-only files on Windows are
1478 made read-write if necessary.
1480 * Share open packfiles across repositories to share descriptors and mmaps.
1482 * Use a map for the treebuilder, making insertion O(1)
1484 * The build system now accepts an option EMBED_SSH_PATH which when set
1485 tells it to include a copy of libssh2 at the given location. This is
1488 * Add support for refspecs with the asterisk in the middle of a
1491 * Fetching now performs opportunistic updates. To achieve this, we
1492 introduce a difference between active and passive refspecs, which
1493 make `git_remote_download()` and `git_remote_fetch()` to take a list of
1494 resfpecs to be the active list, similarly to how git fetch accepts a
1495 list on the command-line.
1497 * The THREADSAFE option to build libgit2 with threading support has
1498 been flipped to be on by default.
1500 * The remote object has learnt to prune remote-tracking branches. If
1501 the remote is configured to do so, this will happen via
1502 `git_remote_fetch()`. You can also call `git_remote_prune()` after
1503 connecting or fetching to perform the prune.
1508 * Introduce `git_buf_text_is_binary()` and `git_buf_text_contains_nul()` for
1509 consumers to perform binary detection on a git_buf.
1511 * `git_branch_upstream_remote()` has been introduced to provide the
1512 branch.<name>.remote configuration value.
1514 * Introduce `git_describe_commit()` and `git_describe_workdir()` to provide
1515 a description of the current commit (and working tree, respectively)
1516 based on the nearest tag or reference
1518 * Introduce `git_merge_bases()` and the `git_oidarray` type to expose all
1519 merge bases between two commits.
1521 * Introduce `git_merge_bases_many()` to expose all merge bases between
1524 * Introduce rebase functionality (using the merge algorithm only).
1525 Introduce `git_rebase_init()` to begin a new rebase session,
1526 `git_rebase_open()` to open an in-progress rebase session,
1527 `git_rebase_commit()` to commit the current rebase operation,
1528 `git_rebase_next()` to apply the next rebase operation,
1529 `git_rebase_abort()` to abort an in-progress rebase and `git_rebase_finish()`
1530 to complete a rebase operation.
1532 * Introduce `git_note_author()` and `git_note_committer()` to get the author
1533 and committer information on a `git_note`, respectively.
1535 * A factory function for ssh has been added which allows to change the
1536 path of the programs to execute for receive-pack and upload-pack on
1537 the server, `git_transport_ssh_with_paths()`.
1539 * The ssh transport supports asking the remote host for accepted
1540 credential types as well as multiple challeges using a single
1541 connection. This requires to know which username you want to connect
1542 as, so this introduces the USERNAME credential type which the ssh
1543 transport will use to ask for the username.
1545 * The `GIT_EPEEL` error code has been introduced when we cannot peel a tag
1546 to the requested object type; if the given object otherwise cannot be
1547 peeled, `GIT_EINVALIDSPEC` is returned.
1549 * Introduce `GIT_REPOSITORY_INIT_RELATIVE_GITLINK` to use relative paths
1550 when writing gitlinks, as is used by git core for submodules.
1552 * `git_remote_prune()` has been added. See above for description.
1555 * Introduce reference transactions, which allow multiple references to
1556 be locked at the same time and updates be queued. This also allows
1557 us to safely update a reflog with arbitrary contents, as we need to
1562 * `git_remote_supported_url()` and `git_remote_is_valid_url()` have been
1563 removed as they have become essentially useless with rsync-style ssh paths.
1565 * `git_clone_into()` and `git_clone_local_into()` have been removed from the
1566 public API in favour of `git_clone callbacks`.
1568 * The option to ignore certificate errors via `git_remote_cert_check()`
1569 is no longer present. Instead, `git_remote_callbacks` has gained a new
1570 entry which lets the user perform their own certificate checks.
1572 ### Breaking API changes
1574 * `git_cherry_pick()` is now `git_cherrypick()`.
1576 * The `git_submodule_update()` function was renamed to
1577 `git_submodule_update_strategy()`. `git_submodule_update()` is now used to
1578 provide functionalty similar to "git submodule update".
1580 * `git_treebuilder_create()` was renamed to `git_treebuilder_new()` to better
1581 reflect it being a constructor rather than something which writes to
1584 * `git_treebuilder_new()` (was `git_treebuilder_create()`) now takes a
1585 repository so that it can query repository configuration.
1586 Subsequently, `git_treebuilder_write()` no longer takes a repository.
1588 * `git_threads_init()` and `git_threads_shutdown()` have been renamed to
1589 `git_libgit2_init()` and `git_libgit2_shutdown()` to better explain what
1590 their purpose is, as it's grown to be more than just about threads.
1592 * `git_libgit2_init()` and `git_libgit2_shutdown()` now return the number of
1593 initializations of the library, so consumers may schedule work on the
1594 first initialization.
1596 * The `git_transport_register()` function no longer takes a priority and takes
1597 a URL scheme name (eg "http") instead of a prefix like "http://"
1599 * `git_index_name_entrycount()` and `git_index_reuc_entrycount()` now
1600 return size_t instead of unsigned int.
1602 * The `context_lines` and `interhunk_lines` fields in `git_diff`_options are
1603 now `uint32_t` instead of `uint16_t`. This allows to set them to `UINT_MAX`,
1604 in effect asking for "infinite" context e.g. to iterate over all the
1605 unmodified lines of a diff.
1607 * `git_status_file()` now takes an exact path. Use `git_status_list_new()` if
1608 pathspec searching is needed.
1610 * `git_note_create()` has changed the position of the notes reference
1611 name to match `git_note_remove()`.
1613 * Rename `git_remote_load()` to `git_remote_lookup()` to bring it in line
1614 with the rest of the lookup functions.
1616 * `git_remote_rename()` now takes the repository and the remote's
1617 current name. Accepting a remote indicates we want to change it,
1618 which we only did partially. It is much clearer if we accept a name
1619 and no loaded objects are changed.
1621 * `git_remote_delete()` now accepts the repository and the remote's name
1622 instead of a loaded remote.
1624 * `git_merge_head` is now `git_annotated_commit`, to better reflect its usage
1625 for multiple functions (including rebase)
1627 * The `git_clone_options` struct no longer provides the `ignore_cert_errors` or
1628 `remote_name` members for remote customization.
1630 Instead, the `git_clone_options` struct has two new members, `remote_cb` and
1631 `remote_cb_payload`, which allow the caller to completely override the remote
1632 creation process. If needed, the caller can use this callback to give their
1633 remote a name other than the default (origin) or disable cert checking.
1635 The `remote_callbacks` member has been preserved for convenience, although it
1636 is not used when a remote creation callback is supplied.
1638 * The `git_clone`_options struct now provides `repository_cb` and
1639 `repository_cb_payload` to allow the user to create a repository with
1642 * The `git_push` struct to perform a push has been replaced with
1643 `git_remote_upload()`. The refspecs and options are passed as a
1644 function argument. `git_push_update_tips()` is now also
1645 `git_remote_update_tips()` and the callbacks are in the same struct as
1648 * The `git_remote_set_transport()` function now sets a transport factory function,
1649 rather than a pre-existing transport instance.
1651 * The `git_transport` structure definition has moved into the sys/transport.h
1654 * libgit2 no longer automatically sets the OpenSSL locking
1655 functions. This is not something which we can know to do. A
1656 last-resort convenience function is provided in sys/openssl.h,
1657 `git_openssl_set_locking()` which can be used to set the locking.