Skip to content

docs: fix incorrect feature name references in gix-transport#2447

Merged
Sebastian Thiel (Byron) merged 1 commit intoGitoxideLabs:mainfrom
ArcticLampyrid:fix-docs-gix-transport-features
Feb 25, 2026
Merged

docs: fix incorrect feature name references in gix-transport#2447
Sebastian Thiel (Byron) merged 1 commit intoGitoxideLabs:mainfrom
ArcticLampyrid:fix-docs-gix-transport-features

Conversation

@ArcticLampyrid
Copy link
Copy Markdown
Contributor

Summary

This PR fixes documentation issues in gix-transport/Cargo.toml related to the reqwest feature names:

  1. Incorrect feature name references: Replaced blocking-http-transport-reqwest with the correct http-client-reqwest in the feature documentation comments. These incorrect references were carried over from a March 2024 PR (Remove dep reqwest from gix #1329) that migrated the rustls feature into gix-transport.

  2. Clarified HTTPS support: Added a note to the http-client-reqwest feature documentation that HTTPS is NOT supported by default. Users must enable one of:

    • http-client-reqwest-rust-tls
    • http-client-reqwest-native-tls

    This addresses user confusion where HTTPS requests would fail with an unhelpful error message when only http-client-reqwest was enabled.

Related

Fixes #2425

Changes

-## Implies `http-client` and adds support for http and https transports using the blocking version of `reqwest`.
+## Implies `http-client` and adds support for http transports using the blocking version of `reqwest`.
+## NOTE: `https://` is NOT supported by default. You must enable one of the `http-client-reqwest-rust-tls`
+## or `http-client-reqwest-native-tls` features to enable HTTPS support.
 http-client-reqwest = ["reqwest", "http-client"]
-## Stacks with `blocking-http-transport-reqwest` and enables `https://` via the `rustls` crate.
+## Stacks with `http-client-reqwest` and enables `https://` via the `rustls` crate.

Copy link
Copy Markdown
Member

@Byron Sebastian Thiel (Byron) left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot, much appreciated.

- Replace 'blocking-http-transport-reqwest' with correct 'http-client-reqwest'
- Add note that HTTPS is NOT supported by default with http-client-reqwest
- Users must enable http-client-reqwest-rust-tls or http-client-reqwest-native-tls

Fixes GitoxideLabs#2425
@Byron Sebastian Thiel (Byron) force-pushed the fix-docs-gix-transport-features branch from 031e959 to f468491 Compare February 25, 2026 07:26
@Byron Sebastian Thiel (Byron) merged commit f7b21ba into GitoxideLabs:main Feb 25, 2026
30 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: gix_transport features for reqwest refer to blocking-http-transport-reqwest instead of http-client-reqwest

2 participants