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