4 ### Changes or improvements
6 * Patience and minimal diff drivers can now be used for merges.
8 * Merges can now ignore whitespace changes.
10 * Updated binary identification in CRLF filtering to avoid false positives in
13 * Rename and copy detection is enabled for small files.
15 * Checkout can now handle an initial checkout of a repository, making
16 `GIT_CHECKOUT_SAFE_CREATE` unnecessary for users of clone.
18 * The signature parameter in the ref-modifying functions has been
19 removed. Use `git_repository_set_ident()` and
20 `git_repository_ident()` to override the signature to be used.
22 * The local transport now auto-scales the number of threads to use
23 when creating the packfile instead of sticking to one.
25 * Reference renaming now uses the right id for the old value.
27 * The annotated version of branch creation, HEAD detaching and reset
28 allow for specifying the expression from the user to be put into the
31 * `git_rebase_commit` now returns `GIT_EUNMERGED` when you attempt to
32 commit with unstaged changes.
34 * On Mac OS X, we now use SecureTransport to provide the cryptographic
35 support for HTTPS connections insead of OpenSSL.
37 * Checkout can now accept an index for the baseline computations via the
38 `baseline_index` member.
40 * The configuration for fetching is no longer stored inside the
41 `git_remote` struct but has been moved to a `git_fetch_options`. The
42 remote functions now take these options or the callbacks instead of
43 setting them beforehand.
45 * The index now uses diffs for `add_all()` and `update_all()` which
46 gives it a speed boost and closer semantics to git.
48 * The ssh transport now reports the stderr output from the server as
49 the error message, which allows you to get the "repository not
52 * `git_index_conflict_add()` will remove staged entries that exist for
55 * The flags for a `git_diff_file` will now have the `GIT_DIFF_FLAG_EXISTS`
56 bit set when a file exists on that side of the diff. This is useful
57 for understanding whether a side of the diff exists in the presence of
60 * The constructor for a write-stream into the odb now takes
61 `git_off_t` instead of `size_t` for the size of the blob, which
62 allows putting large files into the odb on 32-bit systems.
64 * The remote's push and pull URLs now honor the url.$URL.insteadOf
65 configuration. This allows modifying URL prefixes to a custom
70 * The `git_merge_options` gained a `file_flags` member.
72 * Parsing and retrieving a configuration value as a path is exposed
73 via `git_config_parse_path()` and `git_config_get_path()`
76 * `git_repository_set_ident()` and `git_repository_ident()` serve to
77 set and query which identity will be used when writing to the
80 * `git_config_entry_free()` frees a config entry.
82 * `git_config_get_string_buf()` provides a way to safely retrieve a
83 string from a non-snapshot configuration.
85 * `git_annotated_commit_from_revspec()` allows to get an annotated
86 commit from an extended sha synatx string.
88 * `git_repository_set_head_detached_from_annotated()`,
89 `git_branch_create_from_annotated()` and
90 `git_reset_from_annotated()` allow for the caller to provide an
91 annotated commit through which they can control what expression is
92 put into the reflog as the source/target.
94 * `git_index_add_frombuffer()` can now create a blob from memory
95 buffer and add it to the index which is attached to a repository.
97 * The structure `git_fetch_options` has been added to determine the
98 runtime configuration for fetching, such as callbacks, pruning and
99 autotag behaviour. It has the runtime initializer
100 `git_fetch_init_options()`.
102 * The enum `git_fetch_prune_t` has been added, letting you specify the
103 pruning behaviour for a fetch.
105 * A push operation will notify the caller of what updates it indends
106 to perform on the remote, which provides similar information to
109 * `git_stash_apply()` can now apply a stashed state from the stash list,
110 placing the data into the working directory and index.
112 * `git_stash_pop()` will apply a stashed state (like `git_stash_apply()`)
113 but will remove the stashed state after a successful application.
115 * A new error code `GIT_EEOF` indicates an early EOF from the
116 server. This typically indicates an error with the URL or
117 configuration of the server, and tools can use this to show messages
118 about failing to communicate with the server.
120 * `git_diff_index_to_workdir()` and `git_diff_tree_to_index()` will now
121 produce deltas of type `GIT_DELTA_CONFLICTED` to indicate that the index
122 side of the delta is a conflict.
124 * The `git_status` family of functions will now produce status of type
125 `GIT_STATUS_CONFLICTED` to indicate that a conflict exists for that file
128 * `git_index_entry_is_conflict()` is a utility function to determine if
129 a given index entry has a non-zero stage entry, indicating that it is
130 one side of a conflict.
132 * It is now possible to pass a keypair via a buffer instead of a
133 path. For this, `GIT_CREDTYPE_SSH_MEMORY` and
134 `git_cred_ssh_key_memory_new()` have been added.
138 * `git_remote_save()` and `git_remote_clear_refspecs()` have been
139 removed. Remote's configuration is changed via the configuration
140 directly or through a convenience function which performs changes to
141 the configuration directly.
143 * `git_remote_set_callbacks()`, `git_remote_get_callbacks()` and
144 `git_remote_set_transport()` have been removed and the remote no
145 longer stores this configuration.
147 * `git_remote_set_fetch_refpecs()` and
148 `git_remote_set_push_refspecs()` have been removed. There is no
149 longer a way to set the base refspecs at run-time.
151 ### Breaking API changes
153 * `git_smart_subtransport_cb` now has a `param` parameter.
155 * The `git_merge_options` structure member `flags` has been renamed
158 * The `git_merge_file_options` structure member `flags` is now
159 an unsigned int. It was previously a `git_merge_file_flags_t`.
161 * `GIT_CHECKOUT_SAFE_CREATE` has been removed. Most users will generally
162 be able to switch to `GIT_CHECKOUT_SAFE`, but if you require missing
163 file handling during checkout, you may now use `GIT_CHECKOUT_SAFE |
164 GIT_CHECKOUT_RECREATE_MISSING`.
166 * The `git_clone_options` and `git_submodule_update_options`
167 structures no longer have a `signature` field.
169 * The following functions have removed the signature and/or log message
170 parameters in favour of git-emulating ones.
172 * `git_branch_create()`, `git_branch_move()`
173 * `git_rebase_init()`, `git_rebase_abort()`
174 * `git_reference_symbolic_create_matching()`,
175 `git_reference_symbolic_create()`, `git_reference_create()`,
176 `git_reference_create_matching()`,
177 `git_reference_symbolic_set_target()`,
178 `git_reference_set_target()`, `git_reference_rename()`
179 * `git_remote_update_tips()`, `git_remote_fetch()`, `git_remote_push()`
180 * `git_repository_set_head()`,
181 `git_repository_set_head_detached()`,
182 `git_repository_detach_head()`
185 * `git_config_get_entry()` now gives back a ref-counted
186 `git_config_entry`. You must free it when you no longer need it.
188 * `git_config_get_string()` will return an error if used on a
189 non-snapshot configuration, as there can be no guarantee that the
190 returned pointer is valid.
192 * `git_note_default_ref()` now uses a `git_buf` to return the string,
193 as the string is otherwise not guaranteed to stay allocated.
195 * `git_rebase_operation_current()` will return `GIT_REBASE_NO_OPERATION`
196 if it is called immediately after creating a rebase session but before
197 you have applied the first patch.
199 * `git_rebase_options` now contains a `git_checkout_options` struct
200 that will be used for functions that modify the working directory,
201 namely `git_checkout_init`, `git_checkout_next` and
202 `git_checkout_abort`. As a result, `git_rebase_open` now also takes
203 a `git_rebase_options` and only the `git_rebase_init` and
204 `git_rebase_open` functions take a `git_rebase_options`, where they
205 will persist the options to subsequent `git_rebase` calls.
207 * The `git_clone_options` struct now has fetch options in a
208 `fetch_opts` field instead of remote callbacks in
211 * The remote callbacks has gained a new member `push_negotiation`
212 which gets called before sending the update commands to the server.
214 * The following functions now longer act on a remote instance but
215 change the repository's configuration. Their signatures have changed
218 * `git_remote_set_url()`, `git_remote_seturl()`
219 * `git_remote_add_fetch()`, `git_remote_add_push()` and
220 * `git_remote_set_autotag()`
222 * `git_remote_connect()` and `git_remote_prune()` now take a pointer
225 * `git_remote_fetch()` and `git_remote_download()` now take a pointer
226 to fetch options which determine the runtime configuration.
228 * The `git_remote_autotag_option_t` values have been changed. It has
229 gained a `_FALLBACK` default value to specify no override for the
232 * `git_remote_update_tips()` now takes a pointer to the callbacks as
233 well as a boolean whether to write `FETCH_HEAD` and the autotag
236 * `git_remote_create_anonymous()` no longer takes a fetch refspec as
237 url-only remotes cannot have configured refspecs.
239 * The `git_submodule_update_options` struct now has fetch options in
240 the `fetch_opts` field instead of callbacks in the
241 `remote_callbacks` field.
243 * The `push` function in the `git_transport` interface now takes a
244 pointer to the remote callbacks.
246 * The `git_index_entry` struct's fields' types have been changed to
247 more accurately reflect what is in fact stored in the
248 index. Specifically, time and file size are 32 bits intead of 64, as
249 these values are truncated.
251 * `GIT_EMERGECONFLICT` is now `GIT_ECONFLICT`, which more accurately
252 describes the nature of the error.
257 ### Changes or improvements
259 * `git_signature_new()` now requires a non-empty email address.
261 * Use CommonCrypto libraries for SHA-1 calculation on Mac OS X.
263 * Disable SSL compression and SSLv2 and SSLv3 ciphers in favor of TLSv1
266 * The fetch behavior of remotes with autotag set to `GIT_REMOTE_DOWNLOAD_TAGS_ALL`
267 has been changed to match git 1.9.0 and later. In this mode, libgit2 now
268 fetches all tags in addition to whatever else needs to be fetched.
270 * `git_checkout()` now handles case-changing renames correctly on
271 case-insensitive filesystems; for example renaming "readme" to "README".
273 * The search for libssh2 is now done via pkg-config instead of a
274 custom search of a few directories.
276 * Add support for core.protectHFS and core.protectNTFS. Add more
277 validation for filenames which we write such as references.
279 * The local transport now generates textual progress output like
280 git-upload-pack does ("counting objects").
282 * `git_checkout_index()` can now check out an in-memory index that is not
283 necessarily the repository's index, so you may check out an index
284 that was produced by git_merge and friends while retaining the cached
287 * Remove the default timeout for receiving / sending data over HTTP using
288 the WinHTTP transport layer.
290 * Add SPNEGO (Kerberos) authentication using GSSAPI on Unix systems.
292 * Provide built-in objects for the empty blob (e69de29) and empty
293 tree (4b825dc) objects.
295 * The index' tree cache is now filled upon read-tree and write-tree
296 and the cache is written to disk.
298 * LF -> CRLF filter refuses to handle mixed-EOL files
300 * LF -> CRLF filter now runs when * text = auto (with Git for Windows 1.9.4)
302 * File unlocks are atomic again via rename. Read-only files on Windows are
303 made read-write if necessary.
305 * Share open packfiles across repositories to share descriptors and mmaps.
307 * Use a map for the treebuilder, making insertion O(1)
309 * The build system now accepts an option EMBED_SSH_PATH which when set
310 tells it to include a copy of libssh2 at the given location. This is
313 * Add support for refspecs with the asterisk in the middle of a
316 * Fetching now performs opportunistic updates. To achieve this, we
317 introduce a difference between active and passive refspecs, which
318 make `git_remote_download()` and `git_remote_fetch()` to take a list of
319 resfpecs to be the active list, similarly to how git fetch accepts a
320 list on the command-line.
322 * The THREADSAFE option to build libgit2 with threading support has
323 been flipped to be on by default.
325 * The remote object has learnt to prune remote-tracking branches. If
326 the remote is configured to do so, this will happen via
327 `git_remote_fetch()`. You can also call `git_remote_prune()` after
328 connecting or fetching to perform the prune.
333 * Introduce `git_buf_text_is_binary()` and `git_buf_text_contains_nul()` for
334 consumers to perform binary detection on a git_buf.
336 * `git_branch_upstream_remote()` has been introduced to provide the
337 branch.<name>.remote configuration value.
339 * Introduce `git_describe_commit()` and `git_describe_workdir()` to provide
340 a description of the current commit (and working tree, respectively)
341 based on the nearest tag or reference
343 * Introduce `git_merge_bases()` and the `git_oidarray` type to expose all
344 merge bases between two commits.
346 * Introduce `git_merge_bases_many()` to expose all merge bases between
349 * Introduce rebase functionality (using the merge algorithm only).
350 Introduce `git_rebase_init()` to begin a new rebase session,
351 `git_rebase_open()` to open an in-progress rebase session,
352 `git_rebase_commit()` to commit the current rebase operation,
353 `git_rebase_next()` to apply the next rebase operation,
354 `git_rebase_abort()` to abort an in-progress rebase and `git_rebase_finish()`
355 to complete a rebase operation.
357 * Introduce `git_note_author()` and `git_note_committer()` to get the author
358 and committer information on a `git_note`, respectively.
360 * A factory function for ssh has been added which allows to change the
361 path of the programs to execute for receive-pack and upload-pack on
362 the server, `git_transport_ssh_with_paths()`.
364 * The ssh transport supports asking the remote host for accepted
365 credential types as well as multiple challeges using a single
366 connection. This requires to know which username you want to connect
367 as, so this introduces the USERNAME credential type which the ssh
368 transport will use to ask for the username.
370 * The `GIT_EPEEL` error code has been introduced when we cannot peel a tag
371 to the requested object type; if the given object otherwise cannot be
372 peeled, `GIT_EINVALIDSPEC` is returned.
374 * Introduce `GIT_REPOSITORY_INIT_RELATIVE_GITLINK` to use relative paths
375 when writing gitlinks, as is used by git core for submodules.
377 * `git_remote_prune()` has been added. See above for description.
380 * Introduce reference transactions, which allow multiple references to
381 be locked at the same time and updates be queued. This also allows
382 us to safely update a reflog with arbitrary contents, as we need to
387 * `git_remote_supported_url()` and `git_remote_is_valid_url()` have been
388 removed as they have become essentially useless with rsync-style ssh paths.
390 * `git_clone_into()` and `git_clone_local_into()` have been removed from the
391 public API in favour of `git_clone callbacks`.
393 * The option to ignore certificate errors via `git_remote_cert_check()`
394 is no longer present. Instead, `git_remote_callbacks` has gained a new
395 entry which lets the user perform their own certificate checks.
397 ### Breaking API changes
399 * `git_cherry_pick()` is now `git_cherrypick()`.
401 * The `git_submodule_update()` function was renamed to
402 `git_submodule_update_strategy()`. `git_submodule_update()` is now used to
403 provide functionalty similar to "git submodule update".
405 * `git_treebuilder_create()` was renamed to `git_treebuilder_new()` to better
406 reflect it being a constructor rather than something which writes to
409 * `git_treebuilder_new()` (was `git_treebuilder_create()`) now takes a
410 repository so that it can query repository configuration.
411 Subsequently, `git_treebuilder_write()` no longer takes a repository.
413 * `git_threads_init()` and `git_threads_shutdown()` have been renamed to
414 `git_libgit2_init()` and `git_libgit2_shutdown()` to better explain what
415 their purpose is, as it's grown to be more than just about threads.
417 * `git_libgit2_init()` and `git_libgit2_shutdown()` now return the number of
418 initializations of the library, so consumers may schedule work on the
419 first initialization.
421 * The `git_transport_register()` function no longer takes a priority and takes
422 a URL scheme name (eg "http") instead of a prefix like "http://"
424 * `git_index_name_entrycount()` and `git_index_reuc_entrycount()` now
425 return size_t instead of unsigned int.
427 * The `context_lines` and `interhunk_lines` fields in `git_diff`_options are
428 now `uint32_t` instead of `uint16_t`. This allows to set them to `UINT_MAX`,
429 in effect asking for "infinite" context e.g. to iterate over all the
430 unmodified lines of a diff.
432 * `git_status_file()` now takes an exact path. Use `git_status_list_new()` if
433 pathspec searching is needed.
435 * `git_note_create()` has changed the position of the notes reference
436 name to match `git_note_remove()`.
438 * Rename `git_remote_load()` to `git_remote_lookup()` to bring it in line
439 with the rest of the lookup functions.
441 * `git_remote_rename()` now takes the repository and the remote's
442 current name. Accepting a remote indicates we want to change it,
443 which we only did partially. It is much clearer if we accept a name
444 and no loaded objects are changed.
446 * `git_remote_delete()` now accepts the repository and the remote's name
447 instead of a loaded remote.
449 * `git_merge_head` is now `git_annotated_commit`, to better reflect its usage
450 for multiple functions (including rebase)
452 * The `git_clone_options` struct no longer provides the `ignore_cert_errors` or
453 `remote_name` members for remote customization.
455 Instead, the `git_clone_options` struct has two new members, `remote_cb` and
456 `remote_cb_payload`, which allow the caller to completely override the remote
457 creation process. If needed, the caller can use this callback to give their
458 remote a name other than the default (origin) or disable cert checking.
460 The `remote_callbacks` member has been preserved for convenience, although it
461 is not used when a remote creation callback is supplied.
463 * The `git_clone`_options struct now provides `repository_cb` and
464 `repository_cb_payload` to allow the user to create a repository with
467 * The `git_push` struct to perform a push has been replaced with
468 `git_remote_upload()`. The refspecs and options are passed as a
469 function argument. `git_push_update_tips()` is now also
470 `git_remote_update_tips()` and the callbacks are in the same struct as
473 * The `git_remote_set_transport()` function now sets a transport factory function,
474 rather than a pre-existing transport instance.
476 * The `git_transport` structure definition has moved into the sys/transport.h
479 * libgit2 no longer automatically sets the OpenSSL locking
480 functions. This is not something which we can know to do. A
481 last-resort convenience function is provided in sys/openssl.h,
482 `git_openssl_set_locking()` which can be used to set the locking.