[Clippy] Address most clippy issues in production code by DanielEScherzer · Pull Request #1291 · rust-lang/git2-rs

DanielEScherzer · 2026-07-15T01:23:47Z

Commits are split by file and lint for ease of review. In most cases, the lints are addressed by fixing the reported issue as suggested.

API changes

Notably, the following public API changes were made:

New `Default` implementations

The following types now implement the Default trait:

ApplyOptions
CherrypickOptions
DiffPatchidOptions
RepositoryInitOptions
RevertOptions
WorktreeAddOptions
WorktreePruneOptions

New `is_empty()` methods

The following types have a new is_empty() method to go along with the existing len() method:

MessageTrailersStrs
MessageTrailersBytes
OdbObject
Rebase

Other

the CloneLocal enum is marked as #[non_exhaustive], and the __Nonexhaustive variant was removed
the implementations of the Into trait for converting TreeWalkResult to i32 and to raw::git_treewalk_mode were replaced with implementations of the From trait

Lints expected

In a few places, addressing the clippy issues would have required breaking changes to the existing API. Accordingly, instead of addressing the issues, the module-level #[allow] attributes were replaced with method-level #[expect] attributes, ensuring that new functions do not have the same issues while maintaining backwards compatibility. The follwing methods are expected to trigger clippy lints:

`clippy::should_implement_trait`

ConfigEntries::next()
Cred::default()
Error::from_str()
ObjectType::from_str()
Oid::from_str()

`clippy::too_many_arguments`

Email::from_diff()
Repository::diff_blobs()

Remaining `#[allow]` attributes

This PR does not address code for tests (code in src/test.rs, code in mod tests inline modules, or code in the tests directory). It also does not address code for examples (the examples) directory. When a file-wide #[allow] turned out to also be needed for the inline test modules, it was added to the tests module.

The library-wide clippy::unnecessary_cast allowing specified in src/lib.rs is also not addressed. Given that some of the casts are needed on unix but not windows, and others are needed on windows but not unix, that lint requires further attention. A dedicated PR already exists at #1238 reduce the unnecessary casts.

Add safety documentation for `ApplyOptions::raw()` regarding using the raw pointer.

Add an implementation of the `Default` trait for `ApplyOptions` that delegates to `ApplyOptions::new()`.

Simplify `BlameHunk::summary()` to use the tuple variant `Some` rather than using a closure.

In the `std::io::Write` trait implementation for `BlobWriter`, use the helper function `std::io::Error::other()` for constructing an `std::io::Error` of kind `std::io::ErrorKind::other`.

Add the missing `# Safety` heading to the existing safety documentation for `Branches::from_raw()` and expand that documentation.

Remove the explicit dereferencing in `Buf::as_str()`.

Mark the `CloneLocal` enum as `#[non_exhaustive]` and remove the hidden `__Nonexhaustive` variant. Based on the libgit2 documentation of the `git_clone_local_t` type the `__Nonexhaustive` was not something that the upstream library used as an actual value.

Add the missing `# Safety` heading to the existing safety documentation for `CheckoutBuilder::configure()` and expand that documentation.

Remove needless lifetimes from the implementation of the `Convert` trait for - converting references (`&T`) to constant pointers (`*const T`) - converting mutable references (`&mut T`) to mutable pointers (`*mut T`)

Add an implementation of the `Default` trait for `CherrypickOptions` that delegates to `CherrypickOptions::new()`.

Simplify a few methods to use the tuple variant `Some` rather than using a closure: - `Commit::message_encoding()` - `Commit::summary()` - `Commit::body()`

Because the method with the confusing name (`ConfigEntries::next()`) is part of the public API of the crate, simply move the lint handling to that method with an `#[expect]` attribute. Doing so avoids breaking changes while also removing the `#![allow]` from the overall module, ensuring that new functions do not have confusing names.

Simplify `CredentialHelper::add_command()` using `str::strip_prefix()`.

Simplify `CredentialHelper::config_use_http_path()` by using if-let expressions with `Results` rather than calling `Result::ok()` and matching against the resulting `Option`.

Add safety documentation for `Cred::unwrap()`.

Simplify `CredentialHelper::url_key()` to avoid needless borrows.

…red.rs Simplify `CredentialHelper::execute_cmd()` to avoid a needless borrow.

Because the method with the confusing name (`Cred::default()`) is part of the public API of the crate, simply move the lint handling to that method with an `#[expect]` attribute. Doing so avoids breaking changes while also removing the `#![allow]` from the overall module, ensuring that new functions do not have confusing names.

Add actual documentation to the `Addition`, `Deletion`, and `HunkHeader` variants of the `DiffLineType` enum.

Add the missing `# Safety` heading to the existing safety documentation for `DiffOptions::raw()`. Add safety documentation for `DiffFindOptions::raw()`.

Add an implementation of the `Default` trait for `DiffPatchidOptions` that delegates to `DiffPatchidOptions::new()`.

Because the method that accepts too many arguments (`Email::from_diff()`) is part of the public API of the crate, simply move the lint handling to that method with an `#[expect]` attribute. Doing so avoids breaking changes while also removing the `#![allow]` from the overall module, ensuring that new functions do not have too many arguments.

Because the method with the confusing name (`Error::from_str()`) is part of the public API of the crate, simply move the lint handling to that method with an `#[expect]` attribute. Doing so avoids breaking changes while also removing the `#![allow]` from the overall module, ensuring that new functions do not have confusing names.

In the `std::io::Write` trait implementation for `Indexer`, use the helper function `std::io::Error::other()` for constructing an `std::io::Error` of kind `std::io::ErrorKind::other`.

Remove needless lifetimes from the `opt_bytes()` function.

Because the method with the confusing name (`ObjectType::from_str()`) is part of the public API of the crate, simply move the lint handling to that method with an `#[expect]` attribute. Doing so avoids breaking changes while also removing the `#![allow]` from the overall module, ensuring that new functions do not have confusing names. Since lints that are `#![allow]`ed in src/lib.rs are also allowed in other files, the removal of the `#![allow]` surfaces warnings in src/oid.rs. For now, allow the current violation at a module level, to be addressed shortly.

Add safety documentation for `MergeOptions::raw()`.

Simplify `MergeFileResult::path()` to use the tuple variant `Some` rather than using a closure.

Add new public methods `MessageTrailersStrs::is_empty()` and `MessageTrailersBytes::is_empty()` for checking if a message's trailers are empty. Internally, introduce `MessageTrailers::is_empty()` to handle the logic.

Add an implementation of the `Default` trait for `RepositoryInitOptions` that delegates to `RepositoryInitOptions::new()`.

Simplify `Repository::namespace()` to use the tuple variant `Some` rather than using a closure.

Because the method that accepts too many arguments (`Repository::diff_blobs()`) is part of the public API of the crate, simply move the lint handling to that method with an `#[expect]` attribute. Doing so avoids breaking changes while also removing the `#![allow]` from the overall module, ensuring that new functions do not have too many arguments.

In `Repository::revert()` use `std::ptr::null()` for the revert options pointer passed to `git_revert()` if no options are provided by the caller.

Add an implementation of the `Default` trait for `RevertOptions` that delegates to `RevertOptions::new()`.

Add the missing `# Safety` heading to the existing safety documentation for `StashSaveOptions::raw()`.

Add the missing `# Safety` heading to the existing safety documentation for `StatusOptions::raw()`.

Simplify `StringArray::get()` to use the tuple variant `Some` rather than using a closure.

…dule.rs Add an empty comment line (`///`) between the paragraphs of the documentation for `Submodule::repo_init()`.

Remove the unneeded assignment in `Submodule::raw()`.

Simplify a few methods to use the tuple variant `Some` rather than using a closure: - `Submodule::branch()` - `Submodule::url()`

Remove the `#![allow]` attribute, apparently something has changed since I initially added it and clippy no longer complains.

Simplify `Tag::message()` to use the tuple variant `Some` rather than using a closure.

Add the missing `# Safety` heading to the existing safety documentation for `register()`.

…port.rs Add the missing annotations to: - `subtransport_action()` - `subtransport_free()` - `stream_free()`

Convert the implementations of conversions from `TreeWalkResult` to `i32` and `raw::git_treewalk_mode` from the `Into` trait to the `From` trait.

Simplify `treewalk_cb()` to use `Option::unwrap_or()`.

Add safety documentation for `Binding::from_raw()` and `Binding::from_raw_opt()`.

Remove needless lifetimes from the `IntoCString` trait implementations for - references to clonable types implementing `IntoCString` (`&T`) - references to string slices - references to `std::path::Path` objects - references to `std::ffi::OsStr` objects - references to `u8` slices

Simplify the `fixup_windows_path()` function to iterate by mutable reference to the path bytes rather than using a range and reading and writing bytes by index.

Remove unneeded `return`s in `path_to_repo_path()`.

Add an implementation of the `Default` trait for `WorktreeAddOptions` that delegates to `WorktreeAddOptions::new()`. Add an implementation of the `Default` trait for `WorktreePruneOptions` that delegates to `WorktreePruneOptions::new()`.

Simplify `Worktree::name()` to use the tuple variant `Some` rather than using a closure.

DanielEScherzer · 2026-07-15T01:49:37Z

For the claim about from implementations for TreeWalkResult: https://play.rust-lang.org/?version=stable&mode=debug&edition=2024&gist=14aafe81106484b31590080fdd2386ae

weihanglo

Thanks. This a huge work!

BTW, is it possible to convert all #[allow] to #[expect]?

View changes since this review

weihanglo · 2026-07-15T01:41:10Z

    }
 }

+impl<'cb> Default for ApplyOptions<'cb> {


I am actually not fond of this. This may not be useful if we don't really need it. And that was why rust-lang/cargo only turn on a subset of lint group https://github.com/rust-lang/cargo/blob/371a35405026fc16dd9968589f13cd746b96e024/Cargo.toml#L139-L145.

Some of them are too pedantic.

weihanglo · 2026-07-15T01:42:34Z

 }

 #[test]
+#[allow(clippy::explicit_auto_deref)]


I forgot in the last PR. we should use #[expect] instead for all #[allow].

weihanglo · 2026-07-15T01:43:46Z

    /// This method is unsafe as there is no guarantee that this structure will
-    /// outlive the provided checkout options.
+    /// outlive the provided checkout options. The caller must ensure that
+    /// `opts` does not outlive the `CheckoutBuilder`, and also that for any


Intra doc link would be nice:

[`CheckoutBuilder`]

weihanglo · 2026-07-15T01:44:49Z


 #[cfg(test)]
 #[cfg(feature = "cred")]
+#[allow(clippy::needless_borrows_for_generic_args)]


#[expect]

weihanglo · 2026-07-15T01:45:44Z

@@ -1,3 +1,5 @@
+#![allow(clippy::should_implement_trait)]


#[expect]

this gets removed later in the same PR

weihanglo · 2026-07-15T01:46:53Z

-            match writepack.free {
-                Some(free) => free(self.raw),
-                None => (),
+            if let Some(free) = writepack.free {


Like, this one is pretty annoying. It generally doesn't really matter.

weihanglo · 2026-07-15T01:54:29Z

@@ -1,3 +1,5 @@
+#![allow(clippy::should_implement_trait)]


#[expect]

DanielEScherzer · 2026-07-15T02:39:47Z

Thanks. This a huge work!

BTW, is it possible to convert all #[allow] to #[expect]?

I didn't use expect because as I found out both here and on #1238 some lints might fire for one OS but not another
Plus the new allows that are added here are either

moved from the file to the tests, and I will deal with soon
temporarily added to src/oid.rs and I deal with it already in this PR

Should I remove the Default implementations? Disable the lint entirely?

weihanglo · 2026-07-15T03:06:47Z

Should I remove the Default implementations? Disable the lint entirely?

I am fine keeping them anyway. Just share with you my preference :)

moved from the file to the tests, and I will deal with soon

This might be better, if not too many churns.

DanielEScherzer added 5 commits July 14, 2026 15:56

[Clippy] Address clippy::missing_safety_doc in src/apply.rs

250d2ba

Add safety documentation for `ApplyOptions::raw()` regarding using the raw pointer.

[Clippy] Address clippy::new_without_default in src/apply.rs

0daed6c

Add an implementation of the `Default` trait for `ApplyOptions` that delegates to `ApplyOptions::new()`.

[Clippy] Address clippy::redundant_closure in src/blame.rs

d64cf4d

Simplify `BlameHunk::summary()` to use the tuple variant `Some` rather than using a closure.

[Clippy] Address clippy::io_other_error in src/blob.rs

0e9ee13

In the `std::io::Write` trait implementation for `BlobWriter`, use the helper function `std::io::Error::other()` for constructing an `std::io::Error` of kind `std::io::ErrorKind::other`.

[Clippy] Address clippy::missing_safety_doc in src/branch.rs

c26ac63

Add the missing `# Safety` heading to the existing safety documentation for `Branches::from_raw()` and expand that documentation.

rustbot added the S-waiting-on-review Status: Waiting on review label Jul 15, 2026

DanielEScherzer added 24 commits July 14, 2026 18:29

[Clippy] Address clippy::explicit_auto_deref in src/buf.rs

0d39772

Remove the explicit dereferencing in `Buf::as_str()`.

[Clippy] Address clippy::missing_safety_doc in src/build.rs

09c9b64

Add the missing `# Safety` heading to the existing safety documentation for `CheckoutBuilder::configure()` and expand that documentation.

[Clippy] Address clippy::needless_lifetimes in src/call.rs

70fbc8d

Remove needless lifetimes from the implementation of the `Convert` trait for - converting references (`&T`) to constant pointers (`*const T`) - converting mutable references (`&mut T`) to mutable pointers (`*mut T`)

[Clippy] Address clippy::new_without_default in src/cherrypick.rs

a69872f

Add an implementation of the `Default` trait for `CherrypickOptions` that delegates to `CherrypickOptions::new()`.

[Clippy] Address clippy::redundant_closure in src/commit.rs

0c5f65e

Simplify a few methods to use the tuple variant `Some` rather than using a closure: - `Commit::message_encoding()` - `Commit::summary()` - `Commit::body()`

[Clippy] Address clippy::manual_strip in src/cred.rs

d9df71d

Simplify `CredentialHelper::add_command()` using `str::strip_prefix()`.

[Clippy] Address clippy::match_result_ok in src/cred.rs

b90b50e

Simplify `CredentialHelper::config_use_http_path()` by using if-let expressions with `Results` rather than calling `Result::ok()` and matching against the resulting `Option`.

[Clippy] Address clippy::missing_safety_doc in src/cred.rs

eb10fc6

Add safety documentation for `Cred::unwrap()`.

[Clippy] Address clippy::needless_borrowed_reference in src/cred.rs

e6f14c0

Simplify `CredentialHelper::url_key()` to avoid needless borrows.

[Clippy] Address clippy::needless_borrows_for_generic_args in src/c…

41cd540

…red.rs Simplify `CredentialHelper::execute_cmd()` to avoid a needless borrow.

[Clippy] Address clippy::empty_docs in src/diff.rs

47e40bf

Add actual documentation to the `Addition`, `Deletion`, and `HunkHeader` variants of the `DiffLineType` enum.

[Clippy] Address clippy::missing_safety_doc in src/diff.rs

c83d982

Add the missing `# Safety` heading to the existing safety documentation for `DiffOptions::raw()`. Add safety documentation for `DiffFindOptions::raw()`.

[Clippy] Address clippy::new_without_default in src/diff.rs

6a31785

Add an implementation of the `Default` trait for `DiffPatchidOptions` that delegates to `DiffPatchidOptions::new()`.

[Clippy] Address clippy::io_other_error in src/indexer.rs

74f0db8

In the `std::io::Write` trait implementation for `Indexer`, use the helper function `std::io::Error::other()` for constructing an `std::io::Error` of kind `std::io::ErrorKind::other`.

[Clippy] Address clippy::needless_lifetimes in src/lib.rs

b0fc46b

Remove needless lifetimes from the `opt_bytes()` function.

[Clippy] Address clippy::missing_safety_doc in src/merge.rs

65c1bdc

Add safety documentation for `MergeOptions::raw()`.

[Clippy] Address clippy::redundant_closure in src/merge.rs

401b0ac

Simplify `MergeFileResult::path()` to use the tuple variant `Some` rather than using a closure.

[Clippy] Address clippy::len_without_is_empty in src/message.rs

de1d768

Add new public methods `MessageTrailersStrs::is_empty()` and `MessageTrailersBytes::is_empty()` for checking if a message's trailers are empty. Internally, introduce `MessageTrailers::is_empty()` to handle the logic.

DanielEScherzer added 19 commits July 14, 2026 18:30

[Clippy] Address clippy::new_without_default in src/repo.rs

1a71bd4

Add an implementation of the `Default` trait for `RepositoryInitOptions` that delegates to `RepositoryInitOptions::new()`.

[Clippy] Address clippy::redundant_closure in src/repo.rs

3c99fed

Simplify `Repository::namespace()` to use the tuple variant `Some` rather than using a closure.

[Clippy] Address clippy::zero_ptr in src/repo.rs

eb86294

In `Repository::revert()` use `std::ptr::null()` for the revert options pointer passed to `git_revert()` if no options are provided by the caller.

[Clippy] Address clippy::new_without_default in src/revert.rs

cb52bc9

Add an implementation of the `Default` trait for `RevertOptions` that delegates to `RevertOptions::new()`.

[Clippy] Address clippy::missing_safety_doc in src/revert.rs

4df6bb9

Add the missing `# Safety` heading to the existing safety documentation for `StashSaveOptions::raw()`.

[Clippy] Address clippy::missing_safety_doc in src/status.rs

20e89a6

Add the missing `# Safety` heading to the existing safety documentation for `StatusOptions::raw()`.

[Clippy] Address clippy::redundant_closure in src/string_array.rs

bed0daa

Simplify `StringArray::get()` to use the tuple variant `Some` rather than using a closure.

[Clippy] Address clippy::empty_line_after_doc_comments in src/submo…

1f16b4c

…dule.rs Add an empty comment line (`///`) between the paragraphs of the documentation for `Submodule::repo_init()`.

[Clippy] Address clippy::let_and_return in src/submodule.rs

76fa2db

Remove the unneeded assignment in `Submodule::raw()`.

[Clippy] Address clippy::redundant_closure in src/submodule.rs

08af1c5

Simplify a few methods to use the tuple variant `Some` rather than using a closure: - `Submodule::branch()` - `Submodule::url()`

[Clippy] Address clippy::from_over_into in src/tag.rs

49b9ccf

Remove the `#![allow]` attribute, apparently something has changed since I initially added it and clippy no longer complains.

[Clippy] Address clippy::redundant_closure in src/tag.rs

9b80d16

Simplify `Tag::message()` to use the tuple variant `Some` rather than using a closure.

[Clippy] Address clippy::missing_safety_doc in src/transport.rs

63dd692

Add the missing `# Safety` heading to the existing safety documentation for `register()`.

[Clippy] Address clippy::missing_transmute_annotations in src/trans…

f4070ef

…port.rs Add the missing annotations to: - `subtransport_action()` - `subtransport_free()` - `stream_free()`

[Clippy] Address clippy::from_over_into in src/tree.rs

e35e127

Convert the implementations of conversions from `TreeWalkResult` to `i32` and `raw::git_treewalk_mode` from the `Into` trait to the `From` trait.

[Clippy] Address clippy::manual_unwrap_or in src/tree.rs

85b9213

Simplify `treewalk_cb()` to use `Option::unwrap_or()`.

[Clippy] Address clippy::missing_safety_doc in src/util.rs

a1a1adf

Add safety documentation for `Binding::from_raw()` and `Binding::from_raw_opt()`.

DanielEScherzer force-pushed the clippy-fixes branch from fc89d15 to 88c7f78 Compare July 15, 2026 01:36

[Clippy] Address clippy::needless_range_loop in src/util.rs

9f4c53d

Simplify the `fixup_windows_path()` function to iterate by mutable reference to the path bytes rather than using a range and reading and writing bytes by index.

DanielEScherzer force-pushed the clippy-fixes branch from 88c7f78 to b8a4250 Compare July 15, 2026 01:48

DanielEScherzer added 3 commits July 14, 2026 18:49

[Clippy] Address clippy::needless_return in src/util.rs

cb0a7ac

Remove unneeded `return`s in `path_to_repo_path()`.

[Clippy] Address clippy::redundant_closure in src/worktree.rs

e45e67c

Simplify `Worktree::name()` to use the tuple variant `Some` rather than using a closure.

DanielEScherzer force-pushed the clippy-fixes branch from b8a4250 to e45e67c Compare July 15, 2026 01:49

weihanglo reviewed Jul 15, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Clippy] Address most clippy issues in production code#1291

[Clippy] Address most clippy issues in production code#1291
DanielEScherzer wants to merge 75 commits into
rust-lang:mainfrom
DanielEScherzer:clippy-fixes

DanielEScherzer commented Jul 15, 2026 •

edited

Loading

Uh oh!

DanielEScherzer commented Jul 15, 2026

Uh oh!

weihanglo left a comment •

edited by rustbot

Loading

Uh oh!

weihanglo Jul 15, 2026

Uh oh!

weihanglo Jul 15, 2026

Uh oh!

weihanglo Jul 15, 2026

Uh oh!

weihanglo Jul 15, 2026

Uh oh!

weihanglo Jul 15, 2026

Uh oh!

DanielEScherzer Jul 15, 2026

Uh oh!

weihanglo Jul 15, 2026

Uh oh!

weihanglo Jul 15, 2026

Uh oh!

DanielEScherzer commented Jul 15, 2026

Uh oh!

weihanglo commented Jul 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

DanielEScherzer commented Jul 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

API changes

New Default implementations

New is_empty() methods

Other

Lints expected

clippy::should_implement_trait

clippy::too_many_arguments

Remaining #[allow] attributes

Uh oh!

DanielEScherzer commented Jul 15, 2026

Uh oh!

weihanglo left a comment • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DanielEScherzer commented Jul 15, 2026

Uh oh!

weihanglo commented Jul 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

DanielEScherzer commented Jul 15, 2026 •

edited

Loading

New `Default` implementations

New `is_empty()` methods

`clippy::should_implement_trait`

`clippy::too_many_arguments`

Remaining `#[allow]` attributes

weihanglo left a comment •

edited by rustbot

Loading