diff options
| author | Josh Triplett <josh@joshtriplett.org> | 2021-11-08 14:00:09 +0100 |
|---|---|---|
| committer | Josh Triplett <josh@joshtriplett.org> | 2021-11-08 14:01:14 +0100 |
| commit | 3993e9aebc7d293e9aec420800c581f7f234def7 (patch) | |
| tree | 291aa4397d14c12c5a4dc4cf90d31886dee3ce81 /include | |
| parent | 358a60e1b46000ea99ef10b4dd709e92f75ff74b (diff) | |
| download | libgit2-3993e9aebc7d293e9aec420800c581f7f234def7.tar.gz | |
Update documentation for ODB backend refresh logic
Commit b1a6c316a6070fac4ab1ec5792979838f7145c39 moved auto-refresh into
the pack backend, and added a comment accordingly. Commit
43820f204ea32503b4083e3b6b83f30a0a0031c9 moved auto-refresh back *out*
of backends into the ODB layer, but didn't update the comment.
Diffstat (limited to 'include')
| -rw-r--r-- | include/git2/sys/odb_backend.h | 7 |
1 files changed, 2 insertions, 5 deletions
diff --git a/include/git2/sys/odb_backend.h b/include/git2/sys/odb_backend.h index 9ae0ed9b3..8598f94e5 100644 --- a/include/git2/sys/odb_backend.h +++ b/include/git2/sys/odb_backend.h @@ -69,11 +69,8 @@ struct git_odb_backend { * If the backend implements a refreshing mechanism, it should be exposed * through this endpoint. Each call to `git_odb_refresh()` will invoke it. * - * However, the backend implementation should try to stay up-to-date as much - * as possible by itself as libgit2 will not automatically invoke - * `git_odb_refresh()`. For instance, a potential strategy for the backend - * implementation to achieve this could be to internally invoke this - * endpoint on failed lookups (ie. `exists()`, `read()`, `read_header()`). + * The odb layer will automatically call this when needed on failed + * lookups (ie. `exists()`, `read()`, `read_header()`). */ int GIT_CALLBACK(refresh)(git_odb_backend *); |