diff options
| author | Edward Thomson <ethomson@edwardthomson.com> | 2019-01-23 00:42:22 +0000 |
|---|---|---|
| committer | Edward Thomson <ethomson@edwardthomson.com> | 2019-01-25 09:06:50 +0000 |
| commit | 769e92749be45ee4a7bf82ef56266680a881027c (patch) | |
| tree | f9f24020741b1f238928d31765ed71877066adc2 /docs | |
| parent | a7d0d14fb03243f571b801804d1b5ac9a2aee725 (diff) | |
| download | libgit2-769e92749be45ee4a7bf82ef56266680a881027c.tar.gz | |
deprecation: update changelog to reflect new policies
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/changelog.md | 20 |
1 files changed, 14 insertions, 6 deletions
diff --git a/docs/changelog.md b/docs/changelog.md index 26899a585..f97f04842 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -112,22 +112,30 @@ v0.27 + 1 ### API removals -### Breaking API changes - * The `git_buf_free` API is deprecated; it has been renamed to `git_buf_dispose` for consistency. The `git_buf_free` API will be - removed in a future release. + retained for backward compatibility for the foreseeable future. * The `git_otype` enumeration and its members are deprecated and have been renamed for consistency. The `GIT_OBJ_` enumeration values are - now prefixed with `GIT_OBJECT_`. The `git_otype` enumeration will - be removed in a future release. + now prefixed with `GIT_OBJECT_`. The old enumerations and macros + will be retained for backward compatibility for the foreseeable future. * Several index-related APIs have been renamed for consistency. The `GIT_IDXENTRY_` enumeration values and macros have been renamed to be prefixed with `GIT_INDEX_ENTRY_`. The `GIT_INDEXCAP` enumeration values are now prefixed with `GIT_INDEX_CAPABILITY_`. The old - enumerations and macros will be removed in a future release. + enumerations and macros will be retained for backward compatibility + for the foreseeable future. + +* The error functions and enumeration values have been renamed for + consistency. The `giterr_` functions and values prefix have been + renamed to be prefixed with `git_error_`; similarly, the `GITERR_` + constants have been renamed to be prefixed with `GIT_ERROR_`. + The old enumerations and macros will be retained for backward + compatibility for the foreseeable future. + +### Breaking API changes * The default checkout strategy changed from `DRY_RUN` to `SAFE` (#4531). |