CHANGELOG.md 16.6 KB
Newer Older
1 2 3
v0.22 + 1
------

4 5
### Changes or improvements

6 7 8 9
* Patience and minimal diff drivers can now be used for merges.

* Merges can now ignore whitespace changes.

10 11 12
* Updated binary identification in CRLF filtering to avoid false positives in
  UTF-8 files.

13 14
* Rename and copy detection is enabled for small files.

15 16 17
* Checkout can now handle an initial checkout of a repository, making
  `GIT_CHECKOUT_SAFE_CREATE` unnecessary for users of clone.

18 19 20 21
* 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.

22 23 24
* The local transport now auto-scales the number of threads to use
  when creating the packfile instead of sticking to one.

25 26 27 28 29 30
* 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.

31
* `git_rebase_commit` now returns `GIT_EUNMERGED` when you attempt to
32 33
  commit with unstaged changes.

34 35 36
* On Mac OS X, we now use SecureTransport to provide the cryptographic
support for HTTPS connections insead of OpenSSL.

37 38 39
* Checkout can now accept an index for the baseline computations via the
  `baseline_index` member.

40 41 42 43 44 45
* 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.


46 47
### API additions

48 49
* The `git_merge_options` gained a `file_flags` member.

50 51 52 53
* Parsing and retrieving a configuration value as a path is exposed
  via `git_config_parse_path()` and `git_config_get_path()`
  respectively.

54 55 56 57
* `git_repository_set_ident()` and `git_repository_ident()` serve to
  set and query which identity will be used when writing to the
  reflog.

58 59 60 61 62
* `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.

63 64 65 66 67 68 69 70
* `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.
71

72
* `git_index_add_frombuffer()` can now create a blob from memory
73 74 75 76 77 78 79 80 81
  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.
82

83 84 85 86 87 88
* `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.

89 90
### API removals

91 92 93 94 95 96 97 98 99
* `git_remote_save()` and `git_remote_clear_refspecs()` has 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 a the remote no
  longer stores this configuration.

100 101
### Breaking API changes

102 103
* `git_smart_subtransport_cb` now has a `param` parameter.

104 105 106
* The `git_merge_options` structure member `flags` has been renamed
  to `tree_flags`.

Shawn Landden committed
107
* The `git_merge_file_options` structure member `flags` is now
108 109
  an unsigned int. It was previously a `git_merge_file_flags_t`.

110 111 112 113 114
* `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`.

115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
* 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()`

134 135 136 137 138 139 140
* `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.

141 142 143
* `git_note_default_ref()` now uses a `git_buf` to return the string,
  as the string is otherwise not guaranteed to stay allocated.

144 145 146 147
* `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.

148 149 150 151 152 153 154 155
* `git_rebase_options` now contains an optional pointer to
  `git_checkout_options` that will be used for functions that modify
  the working directory, namely `git_checkout_init`, `git_checkout_next`
  and `git_checkout_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.

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
* The `git_clone_options` struct now has fetch options in a
  `fetch_opts` field instead of remote callbacks in
  `remote_callbacks`.

* The following functions now 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 poitner
  to fetch options which determine the runtime configuration.

* The `git_remote_autotag_option_t` values have been changed. It has
  gained a `_FALLBACK` 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.

* The `git_submodule_update_options` struct now has fetch options in
  the `fetch_opts` field instead of callbacks in the
  `remote_callbacks` field.

* The `push` function in the `git_transport` interface now takes a
  pointer to the remote callbacks.

189 190 191 192 193
* 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.

194
v0.22
195 196
------

197
### Changes or improvements
198

199
* `git_signature_new()` now requires a non-empty email address.
200

201
* Use CommonCrypto libraries for SHA-1 calculation on Mac OS X.
202

203 204
* Disable SSL compression and SSLv2 and SSLv3 ciphers in favor of TLSv1
  in OpenSSL.
205

206 207 208
* 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.
209

210 211
* `git_checkout()` now handles case-changing renames correctly on
  case-insensitive filesystems; for example renaming "readme" to "README".
212

213 214
* The search for libssh2 is now done via pkg-config instead of a
  custom search of a few directories.
215

216 217
* Add support for core.protectHFS and core.protectNTFS. Add more
  validation for filenames which we write such as references.
218

219 220
* The local transport now generates textual progress output like
  git-upload-pack does ("counting objects").
221

222 223 224 225
* `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.
226

227 228
* Remove the default timeout for receiving / sending data over HTTP using
  the WinHTTP transport layer.
229

230
* Add SPNEGO (Kerberos) authentication using GSSAPI on Unix systems.
231

232 233
* Provide built-in objects for the empty blob (e69de29) and empty
  tree (4b825dc) objects.
234

235 236
* The index' tree cache is now filled upon read-tree and write-tree
  and the cache is written to disk.
237

238
* LF -> CRLF filter refuses to handle mixed-EOL files
239

240
* LF -> CRLF filter now runs when * text = auto (with Git for Windows 1.9.4)
241

242 243
* File unlocks are atomic again via rename. Read-only files on Windows are
  made read-write if necessary.
244

245
* Share open packfiles across repositories to share descriptors and mmaps.
246

247
* Use a map for the treebuilder, making insertion O(1)
248

249 250 251
* 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.
252 253 254

* Add support for refspecs with the asterisk in the middle of a
  pattern.
255

256 257
* Fetching now performs opportunistic updates. To achieve this, we
  introduce a difference between active and passive refspecs, which
258
  make `git_remote_download()` and `git_remote_fetch()` to take a list of
259 260 261
  resfpecs to be the active list, similarly to how git fetch accepts a
  list on the command-line.

262 263
* The THREADSAFE option to build libgit2 with threading support has
  been flipped to be on by default.
264

265 266 267 268 269 270 271
* 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
272

273 274 275 276 277 278 279 280 281 282 283
* 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
284
  merge bases between two commits.
285

286
* Introduce `git_merge_bases_many()` to expose all merge bases between
287
  multiple commits.
288 289

* Introduce rebase functionality (using the merge algorithm only).
290 291 292 293 294
  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()`
295 296
  to complete a rebase operation.

297 298
* Introduce `git_note_author()` and `git_note_committer()` to get the author
  and committer information on a `git_note`, respectively.
299

300 301 302
* 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()`.
303

304 305 306 307 308
* 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.
309

310 311 312
* 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.
313

314 315
* Introduce `GIT_REPOSITORY_INIT_RELATIVE_GITLINK` to use relative paths
  when writing gitlinks, as is used by git core for submodules.
316

317
* `git_remote_prune()` has been added. See above for description.
318

319

320 321 322 323
* 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.
324

325
### API removals
326

327 328 329 330 331 332 333 334 335 336 337
* `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
338

339 340 341 342 343 344 345
* `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
346 347
  reflect it being a constructor rather than something which writes to
  disk.
348

349 350 351
* `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.
352

353 354 355
* `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.
356

357 358 359
* `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.
360

361 362
* The `git_transport_register()` function no longer takes a priority and takes
  a URL scheme name (eg "http") instead of a prefix like "http://"
363

364 365
* `git_index_name_entrycount()` and `git_index_reuc_entrycount()` now
  return size_t instead of unsigned int.
366

367 368 369 370
* 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.
371

372 373
* `git_status_file()` now takes an exact path. Use `git_status_list_new()` if
  pathspec searching is needed.
374

375 376
* `git_note_create()` has changed the position of the notes reference
  name to match `git_note_remove()`.
377

378 379
* Rename `git_remote_load()` to `git_remote_lookup()` to bring it in line
  with the rest of the lookup functions.
380

381 382 383 384
* `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.
385

386 387
* `git_remote_delete()` now accepts the repository and the remote's name
  instead of a loaded remote.
388

389 390
* `git_merge_head` is now `git_annotated_commit`, to better reflect its usage
  for multiple functions (including rebase)
391

392 393
* The `git_clone_options` struct no longer provides the `ignore_cert_errors` or
  `remote_name` members for remote customization.
394

395 396 397 398
  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.
399

400 401
  The `remote_callbacks` member has been preserved for convenience, although it
  is not used when a remote creation callback is supplied.
402

403 404 405
* The `git_clone`_options struct now provides `repository_cb` and
  `repository_cb_payload` to allow the user to create a repository with
  custom options.
406

407 408 409 410 411
* 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.
412

413 414
* The `git_remote_set_transport()` function now sets a transport factory function,
  rather than a pre-existing transport instance.
415

416 417 418 419 420 421 422
* 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.