Skip to content

Commit 769e927

Browse files
committed
deprecation: update changelog to reflect new policies
1 parent a7d0d14 commit 769e927

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

docs/changelog.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -112,22 +112,30 @@ v0.27 + 1
112112

113113
### API removals
114114

115-
### Breaking API changes
116-
117115
* The `git_buf_free` API is deprecated; it has been renamed to
118116
`git_buf_dispose` for consistency. The `git_buf_free` API will be
119-
removed in a future release.
117+
retained for backward compatibility for the foreseeable future.
120118

121119
* The `git_otype` enumeration and its members are deprecated and have
122120
been renamed for consistency. The `GIT_OBJ_` enumeration values are
123-
now prefixed with `GIT_OBJECT_`. The `git_otype` enumeration will
124-
be removed in a future release.
121+
now prefixed with `GIT_OBJECT_`. The old enumerations and macros
122+
will be retained for backward compatibility for the foreseeable future.
125123

126124
* Several index-related APIs have been renamed for consistency. The
127125
`GIT_IDXENTRY_` enumeration values and macros have been renamed to
128126
be prefixed with `GIT_INDEX_ENTRY_`. The `GIT_INDEXCAP` enumeration
129127
values are now prefixed with `GIT_INDEX_CAPABILITY_`. The old
130-
enumerations and macros will be removed in a future release.
128+
enumerations and macros will be retained for backward compatibility
129+
for the foreseeable future.
130+
131+
* The error functions and enumeration values have been renamed for
132+
consistency. The `giterr_` functions and values prefix have been
133+
renamed to be prefixed with `git_error_`; similarly, the `GITERR_`
134+
constants have been renamed to be prefixed with `GIT_ERROR_`.
135+
The old enumerations and macros will be retained for backward
136+
compatibility for the foreseeable future.
137+
138+
### Breaking API changes
131139

132140
* The default checkout strategy changed from `DRY_RUN` to `SAFE` (#4531).
133141

0 commit comments

Comments
 (0)