CHANGELOG.md 13.7 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
### API additions

36 37
* The `git_merge_options` gained a `file_flags` member.

38 39 40 41
* Parsing and retrieving a configuration value as a path is exposed
  via `git_config_parse_path()` and `git_config_get_path()`
  respectively.

42 43 44 45
* `git_repository_set_ident()` and `git_repository_ident()` serve to
  set and query which identity will be used when writing to the
  reflog.

46 47 48 49 50
* `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.

51 52 53 54 55 56 57 58
* `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.
59

60 61 62
* `git_index_add_frombuffer()` can now create a blob from memory
   buffer and add it to the index which is attached to a repository.

63 64 65 66
### API removals

### Breaking API changes

67 68 69
* The `git_merge_options` structure member `flags` has been renamed
  to `tree_flags`.

Shawn Landden committed
70
* The `git_merge_file_options` structure member `flags` is now
71 72
  an unsigned int. It was previously a `git_merge_file_flags_t`.

73 74 75 76 77
* `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`.

78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
* 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()`

97 98 99 100 101 102 103
* `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.

104 105 106
* `git_note_default_ref()` now uses a `git_buf` to return the string,
  as the string is otherwise not guaranteed to stay allocated.

107 108 109 110
* `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.

111 112 113 114 115 116 117 118
* `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.

119
v0.22
120 121
------

122
### Changes or improvements
123

124
* `git_signature_new()` now requires a non-empty email address.
125

126
* Use CommonCrypto libraries for SHA-1 calculation on Mac OS X.
127

128 129
* Disable SSL compression and SSLv2 and SSLv3 ciphers in favor of TLSv1
  in OpenSSL.
130

131 132 133
* 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.
134

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

138 139
* The search for libssh2 is now done via pkg-config instead of a
  custom search of a few directories.
140

141 142
* Add support for core.protectHFS and core.protectNTFS. Add more
  validation for filenames which we write such as references.
143

144 145
* The local transport now generates textual progress output like
  git-upload-pack does ("counting objects").
146

147 148 149 150
* `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.
151

152 153
* Remove the default timeout for receiving / sending data over HTTP using
  the WinHTTP transport layer.
154

155
* Add SPNEGO (Kerberos) authentication using GSSAPI on Unix systems.
156

157 158
* Provide built-in objects for the empty blob (e69de29) and empty
  tree (4b825dc) objects.
159

160 161
* The index' tree cache is now filled upon read-tree and write-tree
  and the cache is written to disk.
162

163
* LF -> CRLF filter refuses to handle mixed-EOL files
164

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

167 168
* File unlocks are atomic again via rename. Read-only files on Windows are
  made read-write if necessary.
169

170
* Share open packfiles across repositories to share descriptors and mmaps.
171

172
* Use a map for the treebuilder, making insertion O(1)
173

174 175 176
* 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.
177 178 179

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

181 182
* Fetching now performs opportunistic updates. To achieve this, we
  introduce a difference between active and passive refspecs, which
183
  make `git_remote_download()` and `git_remote_fetch()` to take a list of
184 185 186
  resfpecs to be the active list, similarly to how git fetch accepts a
  list on the command-line.

187 188
* The THREADSAFE option to build libgit2 with threading support has
  been flipped to be on by default.
189

190 191 192 193 194 195 196
* 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
197

198 199 200 201 202 203 204 205 206 207 208
* 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
209
  merge bases between two commits.
210

211
* Introduce `git_merge_bases_many()` to expose all merge bases between
212
  multiple commits.
213 214

* Introduce rebase functionality (using the merge algorithm only).
215 216 217 218 219
  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()`
220 221
  to complete a rebase operation.

222 223
* Introduce `git_note_author()` and `git_note_committer()` to get the author
  and committer information on a `git_note`, respectively.
224

225 226 227
* 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()`.
228

229 230 231 232 233
* 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.
234

235 236 237
* 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.
238

239 240
* Introduce `GIT_REPOSITORY_INIT_RELATIVE_GITLINK` to use relative paths
  when writing gitlinks, as is used by git core for submodules.
241

242
* `git_remote_prune()` has been added. See above for description.
243

244

245 246 247 248
* 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.
249

250
### API removals
251

252 253 254 255 256 257 258 259 260 261 262
* `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
263

264 265 266 267 268 269 270
* `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
271 272
  reflect it being a constructor rather than something which writes to
  disk.
273

274 275 276
* `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.
277

278 279 280
* `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.
281

282 283 284
* `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.
285

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

289 290
* `git_index_name_entrycount()` and `git_index_reuc_entrycount()` now
  return size_t instead of unsigned int.
291

292 293 294 295
* 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.
296

297 298
* `git_status_file()` now takes an exact path. Use `git_status_list_new()` if
  pathspec searching is needed.
299

300 301
* `git_note_create()` has changed the position of the notes reference
  name to match `git_note_remove()`.
302

303 304
* Rename `git_remote_load()` to `git_remote_lookup()` to bring it in line
  with the rest of the lookup functions.
305

306 307 308 309
* `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.
310

311 312
* `git_remote_delete()` now accepts the repository and the remote's name
  instead of a loaded remote.
313

314 315
* `git_merge_head` is now `git_annotated_commit`, to better reflect its usage
  for multiple functions (including rebase)
316

317 318
* The `git_clone_options` struct no longer provides the `ignore_cert_errors` or
  `remote_name` members for remote customization.
319

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

325 326
  The `remote_callbacks` member has been preserved for convenience, although it
  is not used when a remote creation callback is supplied.
327

328 329 330
* The `git_clone`_options struct now provides `repository_cb` and
  `repository_cb_payload` to allow the user to create a repository with
  custom options.
331

332 333 334 335 336
* 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.
337

338 339
* The `git_remote_set_transport()` function now sets a transport factory function,
  rather than a pre-existing transport instance.
340

341 342 343 344 345 346 347
* 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.