Skip to content

Commit f478a37

Browse files
committed
doc: inform about the absence of strict hash verification and strict object creation.
Those are present in `git2` and enabled by default, and `gitoxde` definitely wants to do the same at some point.
1 parent ed458c0 commit f478a37

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

crate-status.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -615,6 +615,8 @@ See its [README.md](https://github.com/Byron/gitoxide/blob/main/gix-lock/README.
615615
* [x] utilities for applications to make long running operations interruptible gracefully and to support timeouts in servers.
616616
* [x] handle `core.repositoryFormatVersion` and extensions
617617
* [x] support for unicode-precomposition of command-line arguments (needs explicit use in parent application)
618+
* [ ] strict object creation (validate objects referenced by newly created objects exist)
619+
* [ ] strict hash verification (validate that objects actually have the hashes they claim to have)
618620
* **Repository**
619621
* [x] discovery
620622
* [x] option to not cross file systems (default)

gix/src/lib.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,11 @@
7575
//! * [`git2::build::CheckoutBuilder::disable_filters()](https://docs.rs/git2/*/git2/build/struct.CheckoutBuilder.html#method.disable_filters) ➡ ❌ *(filters are always applied during checkouts)*
7676
//! * [`git2::Repository::submodule_status()`](https://docs.rs/git2/*/git2/struct.Repository.html#method.submodule_status) ➡ [`Submodule::state()`] - status provides more information and conveniences though, and an actual worktree status isn't performed.
7777
//!
78+
//! #### Integrity checks
79+
//!
80+
//! `git2` by default performs integrity checks via [`strict_hash_verification()`](https://docs.rs/git2/latest/git2/opts/fn.strict_hash_verification.html) and
81+
//! [`strict_object_creation`](https://docs.rs/git2/latest/git2/opts/fn.strict_object_creation.html) which `gitoxide` *currently* **does not have**.
82+
//!
7883
//! ### Feature Flags
7984
#![cfg_attr(
8085
feature = "document-features",

0 commit comments

Comments
 (0)