From 1c6d51142d6873546f309c1362a1b6cddfd54147 Mon Sep 17 00:00:00 2001 From: Edward Thomson Date: Tue, 7 Jan 2025 20:29:44 +0000 Subject: [PATCH] docs: add `update_refs` as ABI breaking change In v1.9, we failed to document that `update_refs` was a breaking change. Add information about this change to the ABI breaking changes section. --- docs/changelog.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/changelog.md b/docs/changelog.md index 9824d994b..591e51511 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -71,6 +71,13 @@ maintainers of bindings or FFI users, may want to be aware of. to provide a mechanism to nicely free the configuration entries that they provide. +* **`update_refs` callback for remotes** (ABI breaking change) + The `update_refs` callback was added to the `git_remote_callbacks` + structure to provide additional information about updated refs; + in particular, the `git_refspec` is included for more information + about the remote ref. The `update_refs` callback will be + preferred over the now deprecated `update_tips` callback. + ## What's Changed ### New features