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
55 * The `git_merge_options` gained a `file_flags` member.
57 * Parsing and retrieving a configuration value as a path is exposed
58 via `git_config_parse_path()` and `git_config_get_path()`
61 * `git_repository_set_ident()` and `git_repository_ident()` serve to
62 set and query which identity will be used when writing to the
65 * `git_config_entry_free()` frees a config entry.
67 * `git_config_get_string_buf()` provides a way to safely retrieve a
68 string from a non-snapshot configuration.
70 * `git_annotated_commit_from_revspec()` allows to get an annotated
71 commit from an extended sha synatx string.
73 * `git_repository_set_head_detached_from_annotated()`,
74 `git_branch_create_from_annotated()` and
75 `git_reset_from_annotated()` allow for the caller to provide an
76 annotated commit through which they can control what expression is
77 put into the reflog as the source/target.
79 * `git_index_add_frombuffer()` can now create a blob from memory
80 buffer and add it to the index which is attached to a repository.
82 * The structure `git_fetch_options` has been added to determine the
83 runtime configuration for fetching, such as callbacks, pruning and
84 autotag behaviour. It has the runtime initializer
85 `git_fetch_init_options()`.
87 * The enum `git_fetch_prune_t` has been added, letting you specify the
88 pruning behaviour for a fetch.
90 * `git_stash_apply()` can now apply a stashed state from the stash list,
91 placing the data into the working directory and index.
93 * `git_stash_pop()` will apply a stashed state (like `git_stash_apply()`)
94 but will remove the stashed state after a successful application.
96 * A new error code `GIT_EEOF` indicates an early EOF from the
97 server. This typically indicates an error with the URL or
98 configuration of the server, and tools can use this to show messages
99 about failing to communicate with the server.
103 * `git_remote_save()` and `git_remote_clear_refspecs()` has been
104 removed. Remote's configuration is changed via the configuration
105 directly or through a convenience function which performs changes to
106 the configuration directly.
108 * `git_remote_set_callbacks()`, `git_remote_get_callbacks()` and
109 `git_remote_set_transport()` have been removed a the remote no
110 longer stores this configuration.
112 ### Breaking API changes
114 * `git_smart_subtransport_cb` now has a `param` parameter.
116 * The `git_merge_options` structure member `flags` has been renamed
119 * The `git_merge_file_options` structure member `flags` is now
120 an unsigned int. It was previously a `git_merge_file_flags_t`.
122 * `GIT_CHECKOUT_SAFE_CREATE` has been removed. Most users will generally
123 be able to switch to `GIT_CHECKOUT_SAFE`, but if you require missing
124 file handling during checkout, you may now use `GIT_CHECKOUT_SAFE |
125 GIT_CHECKOUT_RECREATE_MISSING`.
127 * The `git_clone_options` and `git_submodule_update_options`
128 structures no longer have a `signature` field.
130 * The following functions have removed the signature and/or log message
131 parameters in favour of git-emulating ones.
133 * `git_branch_create()`, `git_branch_move()`
134 * `git_rebase_init()`, `git_rebase_abort()`
135 * `git_reference_symbolic_create_matching()`,
136 `git_reference_symbolic_create()`, `git_reference_create()`,
137 `git_reference_create_matching()`,
138 `git_reference_symbolic_set_target()`,
139 `git_reference_set_target()`, `git_reference_rename()`
140 * `git_remote_update_tips()`, `git_remote_fetch()`, `git_remote_push()`
141 * `git_repository_set_head()`,
142 `git_repository_set_head_detached()`,
143 `git_repository_detach_head()`
146 * `git_config_get_entry()` now gives back a ref-counted
147 `git_config_entry`. You must free it when you no longer need it.
149 * `git_config_get_string()` will return an error if used on a
150 non-snapshot configuration, as there can be no guarantee that the
151 returned pointer is valid.
153 * `git_note_default_ref()` now uses a `git_buf` to return the string,
154 as the string is otherwise not guaranteed to stay allocated.
156 * `git_rebase_operation_current()` will return `GIT_REBASE_NO_OPERATION`
157 if it is called immediately after creating a rebase session but before
158 you have applied the first patch.
160 * `git_rebase_options` now contains an optional pointer to
161 `git_checkout_options` that will be used for functions that modify
162 the working directory, namely `git_checkout_init`, `git_checkout_next`
163 and `git_checkout_abort`. As a result, `git_rebase_open` now also
164 takes a `git_rebase_options` and only the `git_rebase_init` and
165 `git_rebase_open` functions take a `git_rebase_options`, where they
166 will persist the options to subsequent `git_rebase` calls.
168 * The `git_clone_options` struct now has fetch options in a
169 `fetch_opts` field instead of remote callbacks in
172 * The following functions now longer act on a remote instance but
173 change the repository's configuration. Their signatures have changed
176 * `git_remote_set_url()`, `git_remote_seturl()`
177 * `git_remote_add_fetch()`, `git_remote_add_push()` and
178 * `git_remote_set_autotag()`
180 * `git_remote_connect()` and `git_remote_prune()` now take a pointer
183 * `git_remote_fetch()` and `git_remote_download()` now take a poitner
184 to fetch options which determine the runtime configuration.
186 * The `git_remote_autotag_option_t` values have been changed. It has
187 gained a `_FALLBACK` default value to specify no override for the
190 * `git_remote_update_tips()` now takes a pointer to the callbacks as
191 well as a boolean whether to write `FETCH_HEAD` and the autotag
194 * The `git_submodule_update_options` struct now has fetch options in
195 the `fetch_opts` field instead of callbacks in the
196 `remote_callbacks` field.
198 * The `push` function in the `git_transport` interface now takes a
199 pointer to the remote callbacks.
201 * The `git_index_entry` struct's fields' types have been changed to
202 more accurately reflect what is in fact stored in the
203 index. Specifically, time and file size are 32 bits intead of 64, as
204 these values are truncated.
209 ### Changes or improvements
211 * `git_signature_new()` now requires a non-empty email address.
213 * Use CommonCrypto libraries for SHA-1 calculation on Mac OS X.
215 * Disable SSL compression and SSLv2 and SSLv3 ciphers in favor of TLSv1
218 * The fetch behavior of remotes with autotag set to `GIT_REMOTE_DOWNLOAD_TAGS_ALL`
219 has been changed to match git 1.9.0 and later. In this mode, libgit2 now
220 fetches all tags in addition to whatever else needs to be fetched.
222 * `git_checkout()` now handles case-changing renames correctly on
223 case-insensitive filesystems; for example renaming "readme" to "README".
225 * The search for libssh2 is now done via pkg-config instead of a
226 custom search of a few directories.
228 * Add support for core.protectHFS and core.protectNTFS. Add more
229 validation for filenames which we write such as references.
231 * The local transport now generates textual progress output like
232 git-upload-pack does ("counting objects").
234 * `git_checkout_index()` can now check out an in-memory index that is not
235 necessarily the repository's index, so you may check out an index
236 that was produced by git_merge and friends while retaining the cached
239 * Remove the default timeout for receiving / sending data over HTTP using
240 the WinHTTP transport layer.
242 * Add SPNEGO (Kerberos) authentication using GSSAPI on Unix systems.
244 * Provide built-in objects for the empty blob (e69de29) and empty
245 tree (4b825dc) objects.
247 * The index' tree cache is now filled upon read-tree and write-tree
248 and the cache is written to disk.
250 * LF -> CRLF filter refuses to handle mixed-EOL files
252 * LF -> CRLF filter now runs when * text = auto (with Git for Windows 1.9.4)
254 * File unlocks are atomic again via rename. Read-only files on Windows are
255 made read-write if necessary.
257 * Share open packfiles across repositories to share descriptors and mmaps.
259 * Use a map for the treebuilder, making insertion O(1)
261 * The build system now accepts an option EMBED_SSH_PATH which when set
262 tells it to include a copy of libssh2 at the given location. This is
265 * Add support for refspecs with the asterisk in the middle of a
268 * Fetching now performs opportunistic updates. To achieve this, we
269 introduce a difference between active and passive refspecs, which
270 make `git_remote_download()` and `git_remote_fetch()` to take a list of
271 resfpecs to be the active list, similarly to how git fetch accepts a
272 list on the command-line.
274 * The THREADSAFE option to build libgit2 with threading support has
275 been flipped to be on by default.
277 * The remote object has learnt to prune remote-tracking branches. If
278 the remote is configured to do so, this will happen via
279 `git_remote_fetch()`. You can also call `git_remote_prune()` after
280 connecting or fetching to perform the prune.
285 * Introduce `git_buf_text_is_binary()` and `git_buf_text_contains_nul()` for
286 consumers to perform binary detection on a git_buf.
288 * `git_branch_upstream_remote()` has been introduced to provide the
289 branch.<name>.remote configuration value.
291 * Introduce `git_describe_commit()` and `git_describe_workdir()` to provide
292 a description of the current commit (and working tree, respectively)
293 based on the nearest tag or reference
295 * Introduce `git_merge_bases()` and the `git_oidarray` type to expose all
296 merge bases between two commits.
298 * Introduce `git_merge_bases_many()` to expose all merge bases between
301 * Introduce rebase functionality (using the merge algorithm only).
302 Introduce `git_rebase_init()` to begin a new rebase session,
303 `git_rebase_open()` to open an in-progress rebase session,
304 `git_rebase_commit()` to commit the current rebase operation,
305 `git_rebase_next()` to apply the next rebase operation,
306 `git_rebase_abort()` to abort an in-progress rebase and `git_rebase_finish()`
307 to complete a rebase operation.
309 * Introduce `git_note_author()` and `git_note_committer()` to get the author
310 and committer information on a `git_note`, respectively.
312 * A factory function for ssh has been added which allows to change the
313 path of the programs to execute for receive-pack and upload-pack on
314 the server, `git_transport_ssh_with_paths()`.
316 * The ssh transport supports asking the remote host for accepted
317 credential types as well as multiple challeges using a single
318 connection. This requires to know which username you want to connect
319 as, so this introduces the USERNAME credential type which the ssh
320 transport will use to ask for the username.
322 * The `GIT_EPEEL` error code has been introduced when we cannot peel a tag
323 to the requested object type; if the given object otherwise cannot be
324 peeled, `GIT_EINVALIDSPEC` is returned.
326 * Introduce `GIT_REPOSITORY_INIT_RELATIVE_GITLINK` to use relative paths
327 when writing gitlinks, as is used by git core for submodules.
329 * `git_remote_prune()` has been added. See above for description.
332 * Introduce reference transactions, which allow multiple references to
333 be locked at the same time and updates be queued. This also allows
334 us to safely update a reflog with arbitrary contents, as we need to
339 * `git_remote_supported_url()` and `git_remote_is_valid_url()` have been
340 removed as they have become essentially useless with rsync-style ssh paths.
342 * `git_clone_into()` and `git_clone_local_into()` have been removed from the
343 public API in favour of `git_clone callbacks`.
345 * The option to ignore certificate errors via `git_remote_cert_check()`
346 is no longer present. Instead, `git_remote_callbacks` has gained a new
347 entry which lets the user perform their own certificate checks.
349 ### Breaking API changes
351 * `git_cherry_pick()` is now `git_cherrypick()`.
353 * The `git_submodule_update()` function was renamed to
354 `git_submodule_update_strategy()`. `git_submodule_update()` is now used to
355 provide functionalty similar to "git submodule update".
357 * `git_treebuilder_create()` was renamed to `git_treebuilder_new()` to better
358 reflect it being a constructor rather than something which writes to
361 * `git_treebuilder_new()` (was `git_treebuilder_create()`) now takes a
362 repository so that it can query repository configuration.
363 Subsequently, `git_treebuilder_write()` no longer takes a repository.
365 * `git_threads_init()` and `git_threads_shutdown()` have been renamed to
366 `git_libgit2_init()` and `git_libgit2_shutdown()` to better explain what
367 their purpose is, as it's grown to be more than just about threads.
369 * `git_libgit2_init()` and `git_libgit2_shutdown()` now return the number of
370 initializations of the library, so consumers may schedule work on the
371 first initialization.
373 * The `git_transport_register()` function no longer takes a priority and takes
374 a URL scheme name (eg "http") instead of a prefix like "http://"
376 * `git_index_name_entrycount()` and `git_index_reuc_entrycount()` now
377 return size_t instead of unsigned int.
379 * The `context_lines` and `interhunk_lines` fields in `git_diff`_options are
380 now `uint32_t` instead of `uint16_t`. This allows to set them to `UINT_MAX`,
381 in effect asking for "infinite" context e.g. to iterate over all the
382 unmodified lines of a diff.
384 * `git_status_file()` now takes an exact path. Use `git_status_list_new()` if
385 pathspec searching is needed.
387 * `git_note_create()` has changed the position of the notes reference
388 name to match `git_note_remove()`.
390 * Rename `git_remote_load()` to `git_remote_lookup()` to bring it in line
391 with the rest of the lookup functions.
393 * `git_remote_rename()` now takes the repository and the remote's
394 current name. Accepting a remote indicates we want to change it,
395 which we only did partially. It is much clearer if we accept a name
396 and no loaded objects are changed.
398 * `git_remote_delete()` now accepts the repository and the remote's name
399 instead of a loaded remote.
401 * `git_merge_head` is now `git_annotated_commit`, to better reflect its usage
402 for multiple functions (including rebase)
404 * The `git_clone_options` struct no longer provides the `ignore_cert_errors` or
405 `remote_name` members for remote customization.
407 Instead, the `git_clone_options` struct has two new members, `remote_cb` and
408 `remote_cb_payload`, which allow the caller to completely override the remote
409 creation process. If needed, the caller can use this callback to give their
410 remote a name other than the default (origin) or disable cert checking.
412 The `remote_callbacks` member has been preserved for convenience, although it
413 is not used when a remote creation callback is supplied.
415 * The `git_clone`_options struct now provides `repository_cb` and
416 `repository_cb_payload` to allow the user to create a repository with
419 * The `git_push` struct to perform a push has been replaced with
420 `git_remote_upload()`. The refspecs and options are passed as a
421 function argument. `git_push_update_tips()` is now also
422 `git_remote_update_tips()` and the callbacks are in the same struct as
425 * The `git_remote_set_transport()` function now sets a transport factory function,
426 rather than a pre-existing transport instance.
428 * The `git_transport` structure definition has moved into the sys/transport.h
431 * libgit2 no longer automatically sets the OpenSSL locking
432 functions. This is not something which we can know to do. A
433 last-resort convenience function is provided in sys/openssl.h,
434 `git_openssl_set_locking()` which can be used to set the locking.