Hash :
e2bb9ed3
Author :
Date :
2015-11-04T10:39:55
git_commit_create_buffer()
creates a commit and writes it into a
user-provided buffer instead of writing it into the object db.
git_blob_create_fromstream()
and
git_blob_create_fromstream_commit()
allow you to create a blob by
writing into a stream. Useful when you do not know the final size or
want to copy the contents from another stream.
git_blob_create_fromchunks()
has been removed in favour of
git_blob_create_fromstream()
.
Custom merge drivers can now be registered, which allows callers to
configure callbacks to honor merge=driver
configuration in
.gitattributes
.
Custom filters can now be registered with wildcard attributes, for
example filter=*
. Consumers should examine the attributes parameter
of the check
function for details.
Symlinks are now followed when locking a file, which can be necessary when multiple worktrees share a base repository.
You can now set your own user-agent to be sent for HTTP requests by
using the GIT_OPT_SET_USER_AGENT
with git_libgit2_opts()
.
You can set custom HTTP header fields to be sent along with requests by passing them in the fetch and push options.
Tree objects are now assumed to be sorted. If a tree is not correctly formed, it will give bad results. This is the git approach and cuts a significant amount of time when reading the trees.
Filter registration is now protected against concurrent registration.
Filenames which are not valid on Windows in an index no longer cause to fail to parse it on that OS.
Rebases can now be performed purely in-memory, without touching the repository’s workdir.
When adding objects to the index, or when creating new tree or commit objects, the inputs are validated to ensure that the dependent objects exist and are of the correct type. This object validation can be disabled with the GIT_OPT_ENABLE_STRICT_OBJECT_CREATION option.
The WinHTTP transport’s handling of bad credentials now behaves like the others, asking for credentials again.
git_config_lock()
has been added, which allow for
transactional/atomic complex updates to the configuration, removing
the opportunity for concurrent operations and not committing any
changes until the unlock.
git_diff_options
added a new callback progress_cb
to report on the
progress of the diff as files are being compared. The documentation of
the existing callback notify_cb
was updated to reflect that it only
gets called when new deltas are added to the diff.
git_fetch_options
and git_push_options
have gained a custom_headers
field to set the extra HTTP header fields to send.
git_stream_register_tls()
lets you register a callback to be used
as the constructor for a TLS stream instead of the libgit2 built-in
one.
git_commit_header_field()
allows you to look up a specific header
field in a commit.
git_commit_extract_signature()
extracts the signature from a
commit and gives you both the signature and the signed data so you
can verify it.
git_merge_options
now provides a default_driver
that can be used
to provide the name of a merge driver to be used to handle files changed
during a merge.
The git_merge_tree_flag_t
is now git_merge_flag_t
. Subsequently,
its members are no longer prefixed with GIT_MERGE_TREE_FLAG
but are
now prefixed with GIT_MERGE_FLAG
, and the tree_flags
field of the
git_merge_options
structure is now named flags
.
The git_merge_file_flags_t
enum is now git_merge_file_flag_t
for
consistency with other enum type names.
git_cert
descendent types now have a proper parent
member
It is the responsibility of the refdb backend to decide what to do with the reflog on ref deletion. The file-based backend must delete it, a database-backed one may wish to archive it.
git_config_backend
has gained two entries. lock
and unlock
with which to implement the transactional/atomic semantics for the
configuration backend.
git_index_add
and git_index_conflict_add()
will now use the case
as provided by the caller on case insensitive systems. Previous
versions would keep the case as it existed in the index. This does
not affect the higher-level git_index_add_bypath
or
git_index_add_frombuffer
functions.
The notify_payload
field of git_diff_options
was renamed to payload
to reflect that it’s also the payload for the new progress callback.
The git_config_level_t
enum has gained a higher-priority value
GIT_CONFIG_LEVEL_PROGRAMDATA
which represent a rough Windows equivalent
to the system level configuration.
git_rebase_options
now has a merge_options
field.
The index no longer performs locking itself. This is not something users of the library should have been relying on as it’s not part of the concurrency guarantees.
git_remote_connect()
now takes a custom_headers
argument to set
the extra HTTP header fields to send.
Patience and minimal diff drivers can now be used for merges.
Merges can now ignore whitespace changes.
Updated binary identification in CRLF filtering to avoid false positives in UTF-8 files.
Rename and copy detection is enabled for small files.
Checkout can now handle an initial checkout of a repository, making
GIT_CHECKOUT_SAFE_CREATE
unnecessary for users of clone.
The signature parameter in the ref-modifying functions has been
removed. Use git_repository_set_ident()
and
git_repository_ident()
to override the signature to be used.
The local transport now auto-scales the number of threads to use when creating the packfile instead of sticking to one.
Reference renaming now uses the right id for the old value.
The annotated version of branch creation, HEAD detaching and reset allow for specifying the expression from the user to be put into the reflog.
git_rebase_commit
now returns GIT_EUNMERGED
when you attempt to
commit with unstaged changes.
On Mac OS X, we now use SecureTransport to provide the cryptographic support for HTTPS connections insead of OpenSSL.
Checkout can now accept an index for the baseline computations via the
baseline_index
member.
The configuration for fetching is no longer stored inside the
git_remote
struct but has been moved to a git_fetch_options
. The
remote functions now take these options or the callbacks instead of
setting them beforehand.
git_submodule
instances are no longer cached or shared across
lookup. Each submodule represents the configuration at the time of
loading.
The index now uses diffs for add_all()
and update_all()
which
gives it a speed boost and closer semantics to git.
The ssh transport now reports the stderr output from the server as the error message, which allows you to get the “repository not found” messages.
git_index_conflict_add()
will remove staged entries that exist for
conflicted paths.
The flags for a git_diff_file
will now have the GIT_DIFF_FLAG_EXISTS
bit set when a file exists on that side of the diff. This is useful
for understanding whether a side of the diff exists in the presence of
a conflict.
The constructor for a write-stream into the odb now takes
git_off_t
instead of size_t
for the size of the blob, which
allows putting large files into the odb on 32-bit systems.
The remote’s push and pull URLs now honor the url.$URL.insteadOf configuration. This allows modifying URL prefixes to a custom value via gitconfig.
git_diff_foreach
, git_diff_blobs
, git_diff_blob_to_buffer
,
and git_diff_buffers
now accept a new binary callback of type
git_diff_binary_cb
that includes the binary diff information.
The race condition mitigations described in racy-git.txt
have been
implemented.
If libcurl is installed, we will use it to connect to HTTP(S) servers.
The git_merge_options
gained a file_flags
member.
Parsing and retrieving a configuration value as a path is exposed
via git_config_parse_path()
and git_config_get_path()
respectively.
git_repository_set_ident()
and git_repository_ident()
serve to
set and query which identity will be used when writing to the
reflog.
git_config_entry_free()
frees a config entry.
git_config_get_string_buf()
provides a way to safely retrieve a
string from a non-snapshot configuration.
git_annotated_commit_from_revspec()
allows to get an annotated
commit from an extended sha synatx string.
git_repository_set_head_detached_from_annotated()
,
git_branch_create_from_annotated()
and
git_reset_from_annotated()
allow for the caller to provide an
annotated commit through which they can control what expression is
put into the reflog as the source/target.
git_index_add_frombuffer()
can now create a blob from memory
buffer and add it to the index which is attached to a repository.
The structure git_fetch_options
has been added to determine the
runtime configuration for fetching, such as callbacks, pruning and
autotag behaviour. It has the runtime initializer
git_fetch_init_options()
.
The enum git_fetch_prune_t
has been added, letting you specify the
pruning behaviour for a fetch.
A push operation will notify the caller of what updates it indends to perform on the remote, which provides similar information to git’s pre-push hook.
git_stash_apply()
can now apply a stashed state from the stash list,
placing the data into the working directory and index.
git_stash_pop()
will apply a stashed state (like git_stash_apply()
)
but will remove the stashed state after a successful application.
A new error code GIT_EEOF
indicates an early EOF from the
server. This typically indicates an error with the URL or
configuration of the server, and tools can use this to show messages
about failing to communicate with the server.
A new error code GIT_EINVALID
indicates that an argument to a
function is invalid, or an invalid operation was requested.
git_diff_index_to_workdir()
and git_diff_tree_to_index()
will now
produce deltas of type GIT_DELTA_CONFLICTED
to indicate that the index
side of the delta is a conflict.
The git_status
family of functions will now produce status of type
GIT_STATUS_CONFLICTED
to indicate that a conflict exists for that file
in the index.
git_index_entry_is_conflict()
is a utility function to determine if
a given index entry has a non-zero stage entry, indicating that it is
one side of a conflict.
It is now possible to pass a keypair via a buffer instead of a
path. For this, GIT_CREDTYPE_SSH_MEMORY
and
git_cred_ssh_key_memory_new()
have been added.
git_filter_list_contains
will indicate whether a particular
filter will be run in the given filter list.
git_commit_header_field()
has been added, which allows retrieving
the contents of an arbitrary header field.
git_submodule_set_branch()
allows to set the configured branch for
a submodule.
git_remote_save()
and git_remote_clear_refspecs()
have been
removed. Remote’s configuration is changed via the configuration
directly or through a convenience function which performs changes to
the configuration directly.
git_remote_set_callbacks()
, git_remote_get_callbacks()
and
git_remote_set_transport()
have been removed and the remote no
longer stores this configuration.
git_remote_set_fetch_refpecs()
and
git_remote_set_push_refspecs()
have been removed. There is no
longer a way to set the base refspecs at run-time.
git_submodule_save()
has been removed. The submodules are no
longer configured via the objects.
git_submodule_reload_all()
has been removed as we no longer cache
submodules.
git_smart_subtransport_cb
now has a param
parameter.
The git_merge_options
structure member flags
has been renamed
to tree_flags
.
The git_merge_file_options
structure member flags
is now
an unsigned int. It was previously a git_merge_file_flags_t
.
GIT_CHECKOUT_SAFE_CREATE
has been removed. Most users will generally
be able to switch to GIT_CHECKOUT_SAFE
, but if you require missing
file handling during checkout, you may now use GIT_CHECKOUT_SAFE | GIT_CHECKOUT_RECREATE_MISSING
.
The git_clone_options
and git_submodule_update_options
structures no longer have a signature
field.
The following functions have removed the signature and/or log message parameters in favour of git-emulating ones.
git_branch_create()
, git_branch_move()
git_rebase_init()
, git_rebase_abort()
git_reference_symbolic_create_matching()
,
git_reference_symbolic_create()
, git_reference_create()
,
git_reference_create_matching()
,
git_reference_symbolic_set_target()
,
git_reference_set_target()
, git_reference_rename()
git_remote_update_tips()
, git_remote_fetch()
, git_remote_push()
git_repository_set_head()
,
git_repository_set_head_detached()
,
git_repository_detach_head()
git_reset()
git_config_get_entry()
now gives back a ref-counted
git_config_entry
. You must free it when you no longer need it.
git_config_get_string()
will return an error if used on a
non-snapshot configuration, as there can be no guarantee that the
returned pointer is valid.
git_note_default_ref()
now uses a git_buf
to return the string,
as the string is otherwise not guaranteed to stay allocated.
git_rebase_operation_current()
will return GIT_REBASE_NO_OPERATION
if it is called immediately after creating a rebase session but before
you have applied the first patch.
git_rebase_options
now contains a git_checkout_options
struct
that will be used for functions that modify the working directory,
namely git_rebase_init
, git_rebase_next
and
git_rebase_abort
. As a result, git_rebase_open
now also takes
a git_rebase_options
and only the git_rebase_init
and
git_rebase_open
functions take a git_rebase_options
, where they
will persist the options to subsequent git_rebase
calls.
The git_clone_options
struct now has fetch options in a
fetch_opts
field instead of remote callbacks in
remote_callbacks
.
The remote callbacks has gained a new member push_negotiation
which gets called before sending the update commands to the server.
The following functions no longer act on a remote instance but change the repository’s configuration. Their signatures have changed accordingly:
git_remote_set_url()
, git_remote_seturl()
git_remote_add_fetch()
, git_remote_add_push()
and git_remote_set_autotag()
git_remote_connect()
and git_remote_prune()
now take a pointer
to the callbacks.
git_remote_fetch()
and git_remote_download()
now take a pointer
to fetch options which determine the runtime configuration.
The git_remote_autotag_option_t
values have been changed. It has
gained a _UNSPECIFIED
default value to specify no override for the
configured setting.
git_remote_update_tips()
now takes a pointer to the callbacks as
well as a boolean whether to write FETCH_HEAD
and the autotag
setting.
git_remote_create_anonymous()
no longer takes a fetch refspec as
url-only remotes cannot have configured refspecs.
The git_submodule_update_options
struct now has fetch options in
the fetch_opts
field instead of callbacks in the
remote_callbacks
field.
The following functions no longer act on a submodule instance but change the repository’s configuration. Their signatures have changed accordingly:
git_submodule_set_url()
, git_submodule_set_ignore()
,
git_submodule_set_update()
,
git_submodule_set_fetch_recurse_submodules()
.
git_submodule_status()
no longer takes a submodule instance but a
repsitory, a submodule name and an ignore setting.
The push
function in the git_transport
interface now takes a
pointer to the remote callbacks.
The git_index_entry
struct’s fields’ types have been changed to
more accurately reflect what is in fact stored in the
index. Specifically, time and file size are 32 bits intead of 64, as
these values are truncated.
GIT_EMERGECONFLICT
is now GIT_ECONFLICT
, which more accurately
describes the nature of the error.
It is no longer allowed to call git_buf_grow()
on buffers
borrowing the memory they point to.
git_signature_new()
now requires a non-empty email address.
Use CommonCrypto libraries for SHA-1 calculation on Mac OS X.
Disable SSL compression and SSLv2 and SSLv3 ciphers in favor of TLSv1 in OpenSSL.
The fetch behavior of remotes with autotag set to GIT_REMOTE_DOWNLOAD_TAGS_ALL
has been changed to match git 1.9.0 and later. In this mode, libgit2 now
fetches all tags in addition to whatever else needs to be fetched.
git_checkout()
now handles case-changing renames correctly on
case-insensitive filesystems; for example renaming “readme” to “README”.
The search for libssh2 is now done via pkg-config instead of a custom search of a few directories.
Add support for core.protectHFS and core.protectNTFS. Add more validation for filenames which we write such as references.
The local transport now generates textual progress output like git-upload-pack does (“counting objects”).
git_checkout_index()
can now check out an in-memory index that is not
necessarily the repository’s index, so you may check out an index
that was produced by git_merge and friends while retaining the cached
information.
Remove the default timeout for receiving / sending data over HTTP using the WinHTTP transport layer.
Add SPNEGO (Kerberos) authentication using GSSAPI on Unix systems.
Provide built-in objects for the empty blob (e69de29) and empty tree (4b825dc) objects.
The index’ tree cache is now filled upon read-tree and write-tree and the cache is written to disk.
LF -> CRLF filter refuses to handle mixed-EOL files
LF -> CRLF filter now runs when * text = auto (with Git for Windows 1.9.4)
File unlocks are atomic again via rename. Read-only files on Windows are made read-write if necessary.
Share open packfiles across repositories to share descriptors and mmaps.
Use a map for the treebuilder, making insertion O(1)
The build system now accepts an option EMBED_SSH_PATH which when set tells it to include a copy of libssh2 at the given location. This is enabled for MSVC.
Add support for refspecs with the asterisk in the middle of a pattern.
Fetching now performs opportunistic updates. To achieve this, we
introduce a difference between active and passive refspecs, which
make git_remote_download()
and git_remote_fetch()
to take a list of
resfpecs to be the active list, similarly to how git fetch accepts a
list on the command-line.
The THREADSAFE option to build libgit2 with threading support has been flipped to be on by default.
The remote object has learnt to prune remote-tracking branches. If
the remote is configured to do so, this will happen via
git_remote_fetch()
. You can also call git_remote_prune()
after
connecting or fetching to perform the prune.
Introduce git_buf_text_is_binary()
and git_buf_text_contains_nul()
for
consumers to perform binary detection on a git_buf.
git_branch_upstream_remote()
has been introduced to provide the
branch.<name>.remote configuration value.
Introduce git_describe_commit()
and git_describe_workdir()
to provide
a description of the current commit (and working tree, respectively)
based on the nearest tag or reference
Introduce git_merge_bases()
and the git_oidarray
type to expose all
merge bases between two commits.
Introduce git_merge_bases_many()
to expose all merge bases between
multiple commits.
Introduce rebase functionality (using the merge algorithm only).
Introduce git_rebase_init()
to begin a new rebase session,
git_rebase_open()
to open an in-progress rebase session,
git_rebase_commit()
to commit the current rebase operation,
git_rebase_next()
to apply the next rebase operation,
git_rebase_abort()
to abort an in-progress rebase and git_rebase_finish()
to complete a rebase operation.
Introduce git_note_author()
and git_note_committer()
to get the author
and committer information on a git_note
, respectively.
A factory function for ssh has been added which allows to change the
path of the programs to execute for receive-pack and upload-pack on
the server, git_transport_ssh_with_paths()
.
The ssh transport supports asking the remote host for accepted credential types as well as multiple challeges using a single connection. This requires to know which username you want to connect as, so this introduces the USERNAME credential type which the ssh transport will use to ask for the username.
The GIT_EPEEL
error code has been introduced when we cannot peel a tag
to the requested object type; if the given object otherwise cannot be
peeled, GIT_EINVALIDSPEC
is returned.
Introduce GIT_REPOSITORY_INIT_RELATIVE_GITLINK
to use relative paths
when writing gitlinks, as is used by git core for submodules.
git_remote_prune()
has been added. See above for description.
Introduce reference transactions, which allow multiple references to be locked at the same time and updates be queued. This also allows us to safely update a reflog with arbitrary contents, as we need to do for stash.
git_remote_supported_url()
and git_remote_is_valid_url()
have been
removed as they have become essentially useless with rsync-style ssh paths.
git_clone_into()
and git_clone_local_into()
have been removed from the
public API in favour of git_clone callbacks
.
The option to ignore certificate errors via git_remote_cert_check()
is no longer present. Instead, git_remote_callbacks
has gained a new
entry which lets the user perform their own certificate checks.
git_cherry_pick()
is now git_cherrypick()
.
The git_submodule_update()
function was renamed to
git_submodule_update_strategy()
. git_submodule_update()
is now used to
provide functionalty similar to “git submodule update”.
git_treebuilder_create()
was renamed to git_treebuilder_new()
to better
reflect it being a constructor rather than something which writes to
disk.
git_treebuilder_new()
(was git_treebuilder_create()
) now takes a
repository so that it can query repository configuration.
Subsequently, git_treebuilder_write()
no longer takes a repository.
git_threads_init()
and git_threads_shutdown()
have been renamed to
git_libgit2_init()
and git_libgit2_shutdown()
to better explain what
their purpose is, as it’s grown to be more than just about threads.
git_libgit2_init()
and git_libgit2_shutdown()
now return the number of
initializations of the library, so consumers may schedule work on the
first initialization.
The git_transport_register()
function no longer takes a priority and takes
a URL scheme name (eg “http”) instead of a prefix like “http://“
git_index_name_entrycount()
and git_index_reuc_entrycount()
now
return size_t instead of unsigned int.
The context_lines
and interhunk_lines
fields in git_diff
_options are
now uint32_t
instead of uint16_t
. This allows to set them to UINT_MAX
,
in effect asking for “infinite” context e.g. to iterate over all the
unmodified lines of a diff.
git_status_file()
now takes an exact path. Use git_status_list_new()
if
pathspec searching is needed.
git_note_create()
has changed the position of the notes reference
name to match git_note_remove()
.
Rename git_remote_load()
to git_remote_lookup()
to bring it in line
with the rest of the lookup functions.
git_remote_rename()
now takes the repository and the remote’s
current name. Accepting a remote indicates we want to change it,
which we only did partially. It is much clearer if we accept a name
and no loaded objects are changed.
git_remote_delete()
now accepts the repository and the remote’s name
instead of a loaded remote.
git_merge_head
is now git_annotated_commit
, to better reflect its usage
for multiple functions (including rebase)
The git_clone_options
struct no longer provides the ignore_cert_errors
or
remote_name
members for remote customization.
Instead, the git_clone_options
struct has two new members, remote_cb
and
remote_cb_payload
, which allow the caller to completely override the remote
creation process. If needed, the caller can use this callback to give their
remote a name other than the default (origin) or disable cert checking.
The remote_callbacks
member has been preserved for convenience, although it
is not used when a remote creation callback is supplied.
The git_clone
_options struct now provides repository_cb
and
repository_cb_payload
to allow the user to create a repository with
custom options.
The git_push
struct to perform a push has been replaced with
git_remote_upload()
. The refspecs and options are passed as a
function argument. git_push_update_tips()
is now also
git_remote_update_tips()
and the callbacks are in the same struct as
the rest.
The git_remote_set_transport()
function now sets a transport factory function,
rather than a pre-existing transport instance.
The git_transport
structure definition has moved into the sys/transport.h
file.
libgit2 no longer automatically sets the OpenSSL locking
functions. This is not something which we can know to do. A
last-resort convenience function is provided in sys/openssl.h,
git_openssl_set_locking()
which can be used to set the locking.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670
v0.24 + 1
-------
### Changes or improvements
### API additions
* `git_commit_create_buffer()` creates a commit and writes it into a
user-provided buffer instead of writing it into the object db.
* `git_blob_create_fromstream()` and
`git_blob_create_fromstream_commit()` allow you to create a blob by
writing into a stream. Useful when you do not know the final size or
want to copy the contents from another stream.
### API removals
* `git_blob_create_fromchunks()` has been removed in favour of
`git_blob_create_fromstream()`.
### Breaking API changes
v0.24
-------
### Changes or improvements
* Custom merge drivers can now be registered, which allows callers to
configure callbacks to honor `merge=driver` configuration in
`.gitattributes`.
* Custom filters can now be registered with wildcard attributes, for
example `filter=*`. Consumers should examine the attributes parameter
of the `check` function for details.
* Symlinks are now followed when locking a file, which can be
necessary when multiple worktrees share a base repository.
* You can now set your own user-agent to be sent for HTTP requests by
using the `GIT_OPT_SET_USER_AGENT` with `git_libgit2_opts()`.
* You can set custom HTTP header fields to be sent along with requests
by passing them in the fetch and push options.
* Tree objects are now assumed to be sorted. If a tree is not
correctly formed, it will give bad results. This is the git approach
and cuts a significant amount of time when reading the trees.
* Filter registration is now protected against concurrent
registration.
* Filenames which are not valid on Windows in an index no longer cause
to fail to parse it on that OS.
* Rebases can now be performed purely in-memory, without touching the
repository's workdir.
* When adding objects to the index, or when creating new tree or commit
objects, the inputs are validated to ensure that the dependent objects
exist and are of the correct type. This object validation can be
disabled with the GIT_OPT_ENABLE_STRICT_OBJECT_CREATION option.
* The WinHTTP transport's handling of bad credentials now behaves like
the others, asking for credentials again.
### API additions
* `git_config_lock()` has been added, which allow for
transactional/atomic complex updates to the configuration, removing
the opportunity for concurrent operations and not committing any
changes until the unlock.
* `git_diff_options` added a new callback `progress_cb` to report on the
progress of the diff as files are being compared. The documentation of
the existing callback `notify_cb` was updated to reflect that it only
gets called when new deltas are added to the diff.
* `git_fetch_options` and `git_push_options` have gained a `custom_headers`
field to set the extra HTTP header fields to send.
* `git_stream_register_tls()` lets you register a callback to be used
as the constructor for a TLS stream instead of the libgit2 built-in
one.
* `git_commit_header_field()` allows you to look up a specific header
field in a commit.
* `git_commit_extract_signature()` extracts the signature from a
commit and gives you both the signature and the signed data so you
can verify it.
### API removals
* No APIs were removed in this version.
### Breaking API changes
* `git_merge_options` now provides a `default_driver` that can be used
to provide the name of a merge driver to be used to handle files changed
during a merge.
* The `git_merge_tree_flag_t` is now `git_merge_flag_t`. Subsequently,
its members are no longer prefixed with `GIT_MERGE_TREE_FLAG` but are
now prefixed with `GIT_MERGE_FLAG`, and the `tree_flags` field of the
`git_merge_options` structure is now named `flags`.
* The `git_merge_file_flags_t` enum is now `git_merge_file_flag_t` for
consistency with other enum type names.
* `git_cert` descendent types now have a proper `parent` member
* It is the responsibility of the refdb backend to decide what to do
with the reflog on ref deletion. The file-based backend must delete
it, a database-backed one may wish to archive it.
* `git_config_backend` has gained two entries. `lock` and `unlock`
with which to implement the transactional/atomic semantics for the
configuration backend.
* `git_index_add` and `git_index_conflict_add()` will now use the case
as provided by the caller on case insensitive systems. Previous
versions would keep the case as it existed in the index. This does
not affect the higher-level `git_index_add_bypath` or
`git_index_add_frombuffer` functions.
* The `notify_payload` field of `git_diff_options` was renamed to `payload`
to reflect that it's also the payload for the new progress callback.
* The `git_config_level_t` enum has gained a higher-priority value
`GIT_CONFIG_LEVEL_PROGRAMDATA` which represent a rough Windows equivalent
to the system level configuration.
* `git_rebase_options` now has a `merge_options` field.
* The index no longer performs locking itself. This is not something
users of the library should have been relying on as it's not part of
the concurrency guarantees.
* `git_remote_connect()` now takes a `custom_headers` argument to set
the extra HTTP header fields to send.
v0.23
------
### Changes or improvements
* Patience and minimal diff drivers can now be used for merges.
* Merges can now ignore whitespace changes.
* Updated binary identification in CRLF filtering to avoid false positives in
UTF-8 files.
* Rename and copy detection is enabled for small files.
* Checkout can now handle an initial checkout of a repository, making
`GIT_CHECKOUT_SAFE_CREATE` unnecessary for users of clone.
* The signature parameter in the ref-modifying functions has been
removed. Use `git_repository_set_ident()` and
`git_repository_ident()` to override the signature to be used.
* The local transport now auto-scales the number of threads to use
when creating the packfile instead of sticking to one.
* Reference renaming now uses the right id for the old value.
* The annotated version of branch creation, HEAD detaching and reset
allow for specifying the expression from the user to be put into the
reflog.
* `git_rebase_commit` now returns `GIT_EUNMERGED` when you attempt to
commit with unstaged changes.
* On Mac OS X, we now use SecureTransport to provide the cryptographic
support for HTTPS connections insead of OpenSSL.
* Checkout can now accept an index for the baseline computations via the
`baseline_index` member.
* The configuration for fetching is no longer stored inside the
`git_remote` struct but has been moved to a `git_fetch_options`. The
remote functions now take these options or the callbacks instead of
setting them beforehand.
* `git_submodule` instances are no longer cached or shared across
lookup. Each submodule represents the configuration at the time of
loading.
* The index now uses diffs for `add_all()` and `update_all()` which
gives it a speed boost and closer semantics to git.
* The ssh transport now reports the stderr output from the server as
the error message, which allows you to get the "repository not
found" messages.
* `git_index_conflict_add()` will remove staged entries that exist for
conflicted paths.
* The flags for a `git_diff_file` will now have the `GIT_DIFF_FLAG_EXISTS`
bit set when a file exists on that side of the diff. This is useful
for understanding whether a side of the diff exists in the presence of
a conflict.
* The constructor for a write-stream into the odb now takes
`git_off_t` instead of `size_t` for the size of the blob, which
allows putting large files into the odb on 32-bit systems.
* The remote's push and pull URLs now honor the url.$URL.insteadOf
configuration. This allows modifying URL prefixes to a custom
value via gitconfig.
* `git_diff_foreach`, `git_diff_blobs`, `git_diff_blob_to_buffer`,
and `git_diff_buffers` now accept a new binary callback of type
`git_diff_binary_cb` that includes the binary diff information.
* The race condition mitigations described in `racy-git.txt` have been
implemented.
* If libcurl is installed, we will use it to connect to HTTP(S)
servers.
### API additions
* The `git_merge_options` gained a `file_flags` member.
* Parsing and retrieving a configuration value as a path is exposed
via `git_config_parse_path()` and `git_config_get_path()`
respectively.
* `git_repository_set_ident()` and `git_repository_ident()` serve to
set and query which identity will be used when writing to the
reflog.
* `git_config_entry_free()` frees a config entry.
* `git_config_get_string_buf()` provides a way to safely retrieve a
string from a non-snapshot configuration.
* `git_annotated_commit_from_revspec()` allows to get an annotated
commit from an extended sha synatx string.
* `git_repository_set_head_detached_from_annotated()`,
`git_branch_create_from_annotated()` and
`git_reset_from_annotated()` allow for the caller to provide an
annotated commit through which they can control what expression is
put into the reflog as the source/target.
* `git_index_add_frombuffer()` can now create a blob from memory
buffer and add it to the index which is attached to a repository.
* The structure `git_fetch_options` has been added to determine the
runtime configuration for fetching, such as callbacks, pruning and
autotag behaviour. It has the runtime initializer
`git_fetch_init_options()`.
* The enum `git_fetch_prune_t` has been added, letting you specify the
pruning behaviour for a fetch.
* A push operation will notify the caller of what updates it indends
to perform on the remote, which provides similar information to
git's pre-push hook.
* `git_stash_apply()` can now apply a stashed state from the stash list,
placing the data into the working directory and index.
* `git_stash_pop()` will apply a stashed state (like `git_stash_apply()`)
but will remove the stashed state after a successful application.
* A new error code `GIT_EEOF` indicates an early EOF from the
server. This typically indicates an error with the URL or
configuration of the server, and tools can use this to show messages
about failing to communicate with the server.
* A new error code `GIT_EINVALID` indicates that an argument to a
function is invalid, or an invalid operation was requested.
* `git_diff_index_to_workdir()` and `git_diff_tree_to_index()` will now
produce deltas of type `GIT_DELTA_CONFLICTED` to indicate that the index
side of the delta is a conflict.
* The `git_status` family of functions will now produce status of type
`GIT_STATUS_CONFLICTED` to indicate that a conflict exists for that file
in the index.
* `git_index_entry_is_conflict()` is a utility function to determine if
a given index entry has a non-zero stage entry, indicating that it is
one side of a conflict.
* It is now possible to pass a keypair via a buffer instead of a
path. For this, `GIT_CREDTYPE_SSH_MEMORY` and
`git_cred_ssh_key_memory_new()` have been added.
* `git_filter_list_contains` will indicate whether a particular
filter will be run in the given filter list.
* `git_commit_header_field()` has been added, which allows retrieving
the contents of an arbitrary header field.
* `git_submodule_set_branch()` allows to set the configured branch for
a submodule.
### API removals
* `git_remote_save()` and `git_remote_clear_refspecs()` have been
removed. Remote's configuration is changed via the configuration
directly or through a convenience function which performs changes to
the configuration directly.
* `git_remote_set_callbacks()`, `git_remote_get_callbacks()` and
`git_remote_set_transport()` have been removed and the remote no
longer stores this configuration.
* `git_remote_set_fetch_refpecs()` and
`git_remote_set_push_refspecs()` have been removed. There is no
longer a way to set the base refspecs at run-time.
* `git_submodule_save()` has been removed. The submodules are no
longer configured via the objects.
* `git_submodule_reload_all()` has been removed as we no longer cache
submodules.
### Breaking API changes
* `git_smart_subtransport_cb` now has a `param` parameter.
* The `git_merge_options` structure member `flags` has been renamed
to `tree_flags`.
* The `git_merge_file_options` structure member `flags` is now
an unsigned int. It was previously a `git_merge_file_flags_t`.
* `GIT_CHECKOUT_SAFE_CREATE` has been removed. Most users will generally
be able to switch to `GIT_CHECKOUT_SAFE`, but if you require missing
file handling during checkout, you may now use `GIT_CHECKOUT_SAFE |
GIT_CHECKOUT_RECREATE_MISSING`.
* The `git_clone_options` and `git_submodule_update_options`
structures no longer have a `signature` field.
* The following functions have removed the signature and/or log message
parameters in favour of git-emulating ones.
* `git_branch_create()`, `git_branch_move()`
* `git_rebase_init()`, `git_rebase_abort()`
* `git_reference_symbolic_create_matching()`,
`git_reference_symbolic_create()`, `git_reference_create()`,
`git_reference_create_matching()`,
`git_reference_symbolic_set_target()`,
`git_reference_set_target()`, `git_reference_rename()`
* `git_remote_update_tips()`, `git_remote_fetch()`, `git_remote_push()`
* `git_repository_set_head()`,
`git_repository_set_head_detached()`,
`git_repository_detach_head()`
* `git_reset()`
* `git_config_get_entry()` now gives back a ref-counted
`git_config_entry`. You must free it when you no longer need it.
* `git_config_get_string()` will return an error if used on a
non-snapshot configuration, as there can be no guarantee that the
returned pointer is valid.
* `git_note_default_ref()` now uses a `git_buf` to return the string,
as the string is otherwise not guaranteed to stay allocated.
* `git_rebase_operation_current()` will return `GIT_REBASE_NO_OPERATION`
if it is called immediately after creating a rebase session but before
you have applied the first patch.
* `git_rebase_options` now contains a `git_checkout_options` struct
that will be used for functions that modify the working directory,
namely `git_rebase_init`, `git_rebase_next` and
`git_rebase_abort`. As a result, `git_rebase_open` now also takes
a `git_rebase_options` and only the `git_rebase_init` and
`git_rebase_open` functions take a `git_rebase_options`, where they
will persist the options to subsequent `git_rebase` calls.
* The `git_clone_options` struct now has fetch options in a
`fetch_opts` field instead of remote callbacks in
`remote_callbacks`.
* The remote callbacks has gained a new member `push_negotiation`
which gets called before sending the update commands to the server.
* The following functions no longer act on a remote instance but
change the repository's configuration. Their signatures have changed
accordingly:
* `git_remote_set_url()`, `git_remote_seturl()`
* `git_remote_add_fetch()`, `git_remote_add_push()` and
* `git_remote_set_autotag()`
* `git_remote_connect()` and `git_remote_prune()` now take a pointer
to the callbacks.
* `git_remote_fetch()` and `git_remote_download()` now take a pointer
to fetch options which determine the runtime configuration.
* The `git_remote_autotag_option_t` values have been changed. It has
gained a `_UNSPECIFIED` default value to specify no override for the
configured setting.
* `git_remote_update_tips()` now takes a pointer to the callbacks as
well as a boolean whether to write `FETCH_HEAD` and the autotag
setting.
* `git_remote_create_anonymous()` no longer takes a fetch refspec as
url-only remotes cannot have configured refspecs.
* The `git_submodule_update_options` struct now has fetch options in
the `fetch_opts` field instead of callbacks in the
`remote_callbacks` field.
* The following functions no longer act on a submodule instance but
change the repository's configuration. Their signatures have changed
accordingly:
* `git_submodule_set_url()`, `git_submodule_set_ignore()`,
`git_submodule_set_update()`,
`git_submodule_set_fetch_recurse_submodules()`.
* `git_submodule_status()` no longer takes a submodule instance but a
repsitory, a submodule name and an ignore setting.
* The `push` function in the `git_transport` interface now takes a
pointer to the remote callbacks.
* The `git_index_entry` struct's fields' types have been changed to
more accurately reflect what is in fact stored in the
index. Specifically, time and file size are 32 bits intead of 64, as
these values are truncated.
* `GIT_EMERGECONFLICT` is now `GIT_ECONFLICT`, which more accurately
describes the nature of the error.
* It is no longer allowed to call `git_buf_grow()` on buffers
borrowing the memory they point to.
v0.22
------
### Changes or improvements
* `git_signature_new()` now requires a non-empty email address.
* Use CommonCrypto libraries for SHA-1 calculation on Mac OS X.
* Disable SSL compression and SSLv2 and SSLv3 ciphers in favor of TLSv1
in OpenSSL.
* The fetch behavior of remotes with autotag set to `GIT_REMOTE_DOWNLOAD_TAGS_ALL`
has been changed to match git 1.9.0 and later. In this mode, libgit2 now
fetches all tags in addition to whatever else needs to be fetched.
* `git_checkout()` now handles case-changing renames correctly on
case-insensitive filesystems; for example renaming "readme" to "README".
* The search for libssh2 is now done via pkg-config instead of a
custom search of a few directories.
* Add support for core.protectHFS and core.protectNTFS. Add more
validation for filenames which we write such as references.
* The local transport now generates textual progress output like
git-upload-pack does ("counting objects").
* `git_checkout_index()` can now check out an in-memory index that is not
necessarily the repository's index, so you may check out an index
that was produced by git_merge and friends while retaining the cached
information.
* Remove the default timeout for receiving / sending data over HTTP using
the WinHTTP transport layer.
* Add SPNEGO (Kerberos) authentication using GSSAPI on Unix systems.
* Provide built-in objects for the empty blob (e69de29) and empty
tree (4b825dc) objects.
* The index' tree cache is now filled upon read-tree and write-tree
and the cache is written to disk.
* LF -> CRLF filter refuses to handle mixed-EOL files
* LF -> CRLF filter now runs when * text = auto (with Git for Windows 1.9.4)
* File unlocks are atomic again via rename. Read-only files on Windows are
made read-write if necessary.
* Share open packfiles across repositories to share descriptors and mmaps.
* Use a map for the treebuilder, making insertion O(1)
* The build system now accepts an option EMBED_SSH_PATH which when set
tells it to include a copy of libssh2 at the given location. This is
enabled for MSVC.
* Add support for refspecs with the asterisk in the middle of a
pattern.
* Fetching now performs opportunistic updates. To achieve this, we
introduce a difference between active and passive refspecs, which
make `git_remote_download()` and `git_remote_fetch()` to take a list of
resfpecs to be the active list, similarly to how git fetch accepts a
list on the command-line.
* The THREADSAFE option to build libgit2 with threading support has
been flipped to be on by default.
* The remote object has learnt to prune remote-tracking branches. If
the remote is configured to do so, this will happen via
`git_remote_fetch()`. You can also call `git_remote_prune()` after
connecting or fetching to perform the prune.
### API additions
* Introduce `git_buf_text_is_binary()` and `git_buf_text_contains_nul()` for
consumers to perform binary detection on a git_buf.
* `git_branch_upstream_remote()` has been introduced to provide the
branch.<name>.remote configuration value.
* Introduce `git_describe_commit()` and `git_describe_workdir()` to provide
a description of the current commit (and working tree, respectively)
based on the nearest tag or reference
* Introduce `git_merge_bases()` and the `git_oidarray` type to expose all
merge bases between two commits.
* Introduce `git_merge_bases_many()` to expose all merge bases between
multiple commits.
* Introduce rebase functionality (using the merge algorithm only).
Introduce `git_rebase_init()` to begin a new rebase session,
`git_rebase_open()` to open an in-progress rebase session,
`git_rebase_commit()` to commit the current rebase operation,
`git_rebase_next()` to apply the next rebase operation,
`git_rebase_abort()` to abort an in-progress rebase and `git_rebase_finish()`
to complete a rebase operation.
* Introduce `git_note_author()` and `git_note_committer()` to get the author
and committer information on a `git_note`, respectively.
* A factory function for ssh has been added which allows to change the
path of the programs to execute for receive-pack and upload-pack on
the server, `git_transport_ssh_with_paths()`.
* The ssh transport supports asking the remote host for accepted
credential types as well as multiple challeges using a single
connection. This requires to know which username you want to connect
as, so this introduces the USERNAME credential type which the ssh
transport will use to ask for the username.
* The `GIT_EPEEL` error code has been introduced when we cannot peel a tag
to the requested object type; if the given object otherwise cannot be
peeled, `GIT_EINVALIDSPEC` is returned.
* Introduce `GIT_REPOSITORY_INIT_RELATIVE_GITLINK` to use relative paths
when writing gitlinks, as is used by git core for submodules.
* `git_remote_prune()` has been added. See above for description.
* Introduce reference transactions, which allow multiple references to
be locked at the same time and updates be queued. This also allows
us to safely update a reflog with arbitrary contents, as we need to
do for stash.
### API removals
* `git_remote_supported_url()` and `git_remote_is_valid_url()` have been
removed as they have become essentially useless with rsync-style ssh paths.
* `git_clone_into()` and `git_clone_local_into()` have been removed from the
public API in favour of `git_clone callbacks`.
* The option to ignore certificate errors via `git_remote_cert_check()`
is no longer present. Instead, `git_remote_callbacks` has gained a new
entry which lets the user perform their own certificate checks.
### Breaking API changes
* `git_cherry_pick()` is now `git_cherrypick()`.
* The `git_submodule_update()` function was renamed to
`git_submodule_update_strategy()`. `git_submodule_update()` is now used to
provide functionalty similar to "git submodule update".
* `git_treebuilder_create()` was renamed to `git_treebuilder_new()` to better
reflect it being a constructor rather than something which writes to
disk.
* `git_treebuilder_new()` (was `git_treebuilder_create()`) now takes a
repository so that it can query repository configuration.
Subsequently, `git_treebuilder_write()` no longer takes a repository.
* `git_threads_init()` and `git_threads_shutdown()` have been renamed to
`git_libgit2_init()` and `git_libgit2_shutdown()` to better explain what
their purpose is, as it's grown to be more than just about threads.
* `git_libgit2_init()` and `git_libgit2_shutdown()` now return the number of
initializations of the library, so consumers may schedule work on the
first initialization.
* The `git_transport_register()` function no longer takes a priority and takes
a URL scheme name (eg "http") instead of a prefix like "http://"
* `git_index_name_entrycount()` and `git_index_reuc_entrycount()` now
return size_t instead of unsigned int.
* The `context_lines` and `interhunk_lines` fields in `git_diff`_options are
now `uint32_t` instead of `uint16_t`. This allows to set them to `UINT_MAX`,
in effect asking for "infinite" context e.g. to iterate over all the
unmodified lines of a diff.
* `git_status_file()` now takes an exact path. Use `git_status_list_new()` if
pathspec searching is needed.
* `git_note_create()` has changed the position of the notes reference
name to match `git_note_remove()`.
* Rename `git_remote_load()` to `git_remote_lookup()` to bring it in line
with the rest of the lookup functions.
* `git_remote_rename()` now takes the repository and the remote's
current name. Accepting a remote indicates we want to change it,
which we only did partially. It is much clearer if we accept a name
and no loaded objects are changed.
* `git_remote_delete()` now accepts the repository and the remote's name
instead of a loaded remote.
* `git_merge_head` is now `git_annotated_commit`, to better reflect its usage
for multiple functions (including rebase)
* The `git_clone_options` struct no longer provides the `ignore_cert_errors` or
`remote_name` members for remote customization.
Instead, the `git_clone_options` struct has two new members, `remote_cb` and
`remote_cb_payload`, which allow the caller to completely override the remote
creation process. If needed, the caller can use this callback to give their
remote a name other than the default (origin) or disable cert checking.
The `remote_callbacks` member has been preserved for convenience, although it
is not used when a remote creation callback is supplied.
* The `git_clone`_options struct now provides `repository_cb` and
`repository_cb_payload` to allow the user to create a repository with
custom options.
* The `git_push` struct to perform a push has been replaced with
`git_remote_upload()`. The refspecs and options are passed as a
function argument. `git_push_update_tips()` is now also
`git_remote_update_tips()` and the callbacks are in the same struct as
the rest.
* The `git_remote_set_transport()` function now sets a transport factory function,
rather than a pre-existing transport instance.
* The `git_transport` structure definition has moved into the sys/transport.h
file.
* libgit2 no longer automatically sets the OpenSSL locking
functions. This is not something which we can know to do. A
last-resort convenience function is provided in sys/openssl.h,
`git_openssl_set_locking()` which can be used to set the locking.