CHANGELOG.md

   1 v0.22 + 1
   2 ------
   3
   4 v0.22
   5 ------
   6
   7 ### Changes or improvements
   8
   9 * `git_signature_new()` now requires a non-empty email address.
  10
  11 * Use CommonCrypto libraries for SHA-1 calculation on Mac OS X.
  12
  13 * Disable SSL compression and SSLv2 and SSLv3 ciphers in favor of TLSv1
  14   in OpenSSL.
  15
  16 * The fetch behavior of remotes with autotag set to `GIT_REMOTE_DOWNLOAD_TAGS_ALL`
  17   has been changed to match git 1.9.0 and later. In this mode, libgit2 now
  18   fetches all tags in addition to whatever else needs to be fetched.
  19
  20 * `git_checkout()` now handles case-changing renames correctly on
  21   case-insensitive filesystems; for example renaming "readme" to "README".
  22
  23 * The search for libssh2 is now done via pkg-config instead of a
  24   custom search of a few directories.
  25
  26 * Add support for core.protectHFS and core.protectNTFS. Add more
  27   validation for filenames which we write such as references.
  28
  29 * The local transport now generates textual progress output like
  30   git-upload-pack does ("counting objects").
  31
  32 * `git_checkout_index()` can now check out an in-memory index that is not
  33   necessarily the repository's index, so you may check out an index
  34   that was produced by git_merge and friends while retaining the cached
  35   information.
  36
  37 * Remove the default timeout for receiving / sending data over HTTP using
  38   the WinHTTP transport layer.
  39
  40 * Add SPNEGO (Kerberos) authentication using GSSAPI on Unix systems.
  41
  42 * Provide built-in objects for the empty blob (e69de29) and empty
  43   tree (4b825dc) objects.
  44
  45 * The index' tree cache is now filled upon read-tree and write-tree
  46   and the cache is written to disk.
  47
  48 * LF -> CRLF filter refuses to handle mixed-EOL files
  49
  50 * LF -> CRLF filter now runs when * text = auto (with Git for Windows 1.9.4)
  51
  52 * File unlocks are atomic again via rename. Read-only files on Windows are
  53   made read-write if necessary.
  54
  55 * Share open packfiles across repositories to share descriptors and mmaps.
  56
  57 * Use a map for the treebuilder, making insertion O(1)
  58
  59 * The build system now accepts an option EMBED_SSH_PATH which when set
  60   tells it to include a copy of libssh2 at the given location. This is
  61   enabled for MSVC.
  62
  63 * Add support for refspecs with the asterisk in the middle of a
  64   pattern.
  65
  66 * Fetching now performs opportunistic updates. To achieve this, we
  67   introduce a difference between active and passive refspecs, which
  68   make `git_remote_download()` and `git_remote_fetch()` to take a list of
  69   resfpecs to be the active list, similarly to how git fetch accepts a
  70   list on the command-line.
  71
  72 * The THREADSAFE option to build libgit2 with threading support has
  73   been flipped to be on by default.
  74
  75 * The remote object has learnt to prune remote-tracking branches. If
  76   the remote is configured to do so, this will happen via
  77   `git_remote_fetch()`. You can also call `git_remote_prune()` after
  78   connecting or fetching to perform the prune.
  79
  80
  81 ### API additions
  82
  83 * Introduce `git_buf_text_is_binary()` and `git_buf_text_contains_nul()` for
  84   consumers to perform binary detection on a git_buf.
  85
  86 * `git_branch_upstream_remote()` has been introduced to provide the
  87   branch.<name>.remote configuration value.
  88
  89 * Introduce `git_describe_commit()` and `git_describe_workdir()` to provide
  90   a description of the current commit (and working tree, respectively)
  91   based on the nearest tag or reference
  92
  93 * Introduce `git_merge_bases()` and the `git_oidarray` type to expose all
  94   merge bases between two commits.
  95
  96 * Introduce `git_merge_bases_many()` to expose all merge bases between
  97   multiple commits.
  98
  99 * Introduce rebase functionality (using the merge algorithm only).
 100   Introduce `git_rebase_init()` to begin a new rebase session,
 101   `git_rebase_open()` to open an in-progress rebase session,
 102   `git_rebase_commit()` to commit the current rebase operation,
 103   `git_rebase_next()` to apply the next rebase operation,
 104   `git_rebase_abort()` to abort an in-progress rebase and `git_rebase_finish()`
 105   to complete a rebase operation.
 106
 107 * Introduce `git_note_author()` and `git_note_committer()` to get the author
 108   and committer information on a `git_note`, respectively.
 109
 110 * A factory function for ssh has been added which allows to change the
 111   path of the programs to execute for receive-pack and upload-pack on
 112   the server, `git_transport_ssh_with_paths()`.
 113
 114 * The ssh transport supports asking the remote host for accepted
 115   credential types as well as multiple challeges using a single
 116   connection. This requires to know which username you want to connect
 117   as, so this introduces the USERNAME credential type which the ssh
 118   transport will use to ask for the username.
 119
 120 * The `GIT_EPEEL` error code has been introduced when we cannot peel a tag
 121   to the requested object type; if the given object otherwise cannot be
 122   peeled, `GIT_EINVALIDSPEC` is returned.
 123
 124 * Introduce `GIT_REPOSITORY_INIT_RELATIVE_GITLINK` to use relative paths
 125   when writing gitlinks, as is used by git core for submodules.
 126
 127 * `git_remote_prune()` has been added. See above for description.
 128
 129
 130 * Introduce reference transactions, which allow multiple references to
 131   be locked at the same time and updates be queued. This also allows
 132   us to safely update a reflog with arbitrary contents, as we need to
 133   do for stash.
 134
 135 ### API removals
 136
 137 * `git_remote_supported_url()` and `git_remote_is_valid_url()` have been
 138   removed as they have become essentially useless with rsync-style ssh paths.
 139
 140 * `git_clone_into()` and `git_clone_local_into()` have been removed from the
 141   public API in favour of `git_clone callbacks`.
 142
 143 * The option to ignore certificate errors via `git_remote_cert_check()`
 144   is no longer present. Instead, `git_remote_callbacks` has gained a new
 145   entry which lets the user perform their own certificate checks.
 146
 147 ### Breaking API changes
 148
 149 * `git_cherry_pick()` is now `git_cherrypick()`.
 150
 151 * The `git_submodule_update()` function was renamed to
 152   `git_submodule_update_strategy()`. `git_submodule_update()` is now used to
 153   provide functionalty similar to "git submodule update".
 154
 155 * `git_treebuilder_create()` was renamed to `git_treebuilder_new()` to better
 156   reflect it being a constructor rather than something which writes to
 157   disk.
 158
 159 * `git_treebuilder_new()` (was `git_treebuilder_create()`) now takes a
 160   repository so that it can query repository configuration.
 161   Subsequently, `git_treebuilder_write()` no longer takes a repository.
 162
 163 * `git_threads_init()` and `git_threads_shutdown()` have been renamed to
 164   `git_libgit2_init()` and `git_libgit2_shutdown()` to better explain what
 165   their purpose is, as it's grown to be more than just about threads.
 166
 167 * `git_libgit2_init()` and `git_libgit2_shutdown()` now return the number of
 168   initializations of the library, so consumers may schedule work on the
 169   first initialization.
 170
 171 * The `git_transport_register()` function no longer takes a priority and takes
 172   a URL scheme name (eg "http") instead of a prefix like "http://"
 173
 174 * `git_index_name_entrycount()` and `git_index_reuc_entrycount()` now
 175   return size_t instead of unsigned int.
 176
 177 * The `context_lines` and `interhunk_lines` fields in `git_diff`_options are
 178   now `uint32_t` instead of `uint16_t`. This allows to set them to `UINT_MAX`,
 179   in effect asking for "infinite" context e.g. to iterate over all the
 180   unmodified lines of a diff.
 181
 182 * `git_status_file()` now takes an exact path. Use `git_status_list_new()` if
 183   pathspec searching is needed.
 184
 185 * `git_note_create()` has changed the position of the notes reference
 186   name to match `git_note_remove()`.
 187
 188 * Rename `git_remote_load()` to `git_remote_lookup()` to bring it in line
 189   with the rest of the lookup functions.
 190
 191 * `git_remote_rename()` now takes the repository and the remote's
 192   current name. Accepting a remote indicates we want to change it,
 193   which we only did partially. It is much clearer if we accept a name
 194   and no loaded objects are changed.
 195
 196 * `git_remote_delete()` now accepts the repository and the remote's name
 197   instead of a loaded remote.
 198
 199 * `git_merge_head` is now `git_annotated_commit`, to better reflect its usage
 200   for multiple functions (including rebase)
 201
 202 * The `git_clone_options` struct no longer provides the `ignore_cert_errors` or
 203   `remote_name` members for remote customization.
 204
 205   Instead, the `git_clone_options` struct has two new members, `remote_cb` and
 206   `remote_cb_payload`, which allow the caller to completely override the remote
 207   creation process. If needed, the caller can use this callback to give their
 208   remote a name other than the default (origin) or disable cert checking.
 209
 210   The `remote_callbacks` member has been preserved for convenience, although it
 211   is not used when a remote creation callback is supplied.
 212
 213 * The `git_clone`_options struct now provides `repository_cb` and
 214   `repository_cb_payload` to allow the user to create a repository with
 215   custom options.
 216
 217 * The `git_push` struct to perform a push has been replaced with
 218   `git_remote_upload()`. The refspecs and options are passed as a
 219   function argument. `git_push_update_tips()` is now also
 220   `git_remote_update_tips()` and the callbacks are in the same struct as
 221   the rest.
 222
 223 * The `git_remote_set_transport()` function now sets a transport factory function,
 224   rather than a pre-existing transport instance.
 225
 226 * The `git_transport` structure definition has moved into the sys/transport.h
 227   file.
 228
 229 * libgit2 no longer automatically sets the OpenSSL locking
 230   functions. This is not something which we can know to do. A
 231   last-resort convenience function is provided in sys/openssl.h,
 232   `git_openssl_set_locking()` which can be used to set the locking.