Skip to content

Remove doc_auto_cfg#5162

Merged
apoelstra merged 1 commit intorust-bitcoin:masterfrom
tcharding:push-zpsoktptxzny
Oct 17, 2025
Merged

Remove doc_auto_cfg#5162
apoelstra merged 1 commit intorust-bitcoin:masterfrom
tcharding:push-zpsoktptxzny

Conversation

@tcharding
Copy link
Copy Markdown
Member

@tcharding tcharding commented Oct 17, 2025

This was removed in recent nightly and is breaking all the docs builds when we try and publish crates.

Fix: #5155

This was removed in recent nightly and is breaking all the docs builds
when we try and publish crates.
Copy link
Copy Markdown
Member

@apoelstra apoelstra left a comment

Choose a reason for hiding this comment

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

utACK 3f33240

@github-actions github-actions bot added C-bitcoin PRs modifying the bitcoin crate C-hashes PRs modifying the hashes crate C-units PRs modifying the units crate C-consensus_encoding PRs modifying the consensus-encoding crate C-internals PRs modifying the internals crate C-io PRs modifying the io crate C-primitives C-base58 PRs modifying the base58 crate C-addresses PRs modifying the addresses crate C-p2p C-chacha20_poly1305 PRs modifying the chacha20_poly1305 crate labels Oct 17, 2025
@apoelstra apoelstra merged commit 16d05ce into rust-bitcoin:master Oct 17, 2025
25 checks passed
@yancyribbens
Copy link
Copy Markdown
Contributor

I've had trouble figuring out a good way to know it works on docs.rs before publishing.

@tcharding
Copy link
Copy Markdown
Member Author

tcharding commented Oct 23, 2025

IIUC we can see this worked by looking at the docs for FromStr for any hash type (feature gated on hex).

https://docs.rs/bitcoin-primitives/1.0.0-rc.0/bitcoin_primitives/struct.Txid.html#impl-FromStr-for-Txid

apoelstra added a commit that referenced this pull request Dec 1, 2025
125585f io: Bump version to 0.1.4 (Tobin C. Harding)
765f97b Lift minimum hex dep to 0.2.2 repo wide (Tobin C. Harding)
8ef94c7 fuzz: Add rust lint unexpected_cfgs (Tobin C. Harding)
cb7ff21 bitcoin: Remove stale type from rustdocs (Tobin C. Harding)
41cfae2 io: Fix lifetime warnings (Tobin C. Harding)
2e03f82 fuzz: Fuzz with Rust 1.74 (Tobin C. Harding)
ca99e4d fuzz: Run the recently patched generate-files script (Tobin C. Harding)
688c35f fuzz: Use same actions versions as on master (Tobin C. Harding)
584d65f io: Remove doc_auto_cfg (Tobin C. Harding)
862012d bitcoin: Change rust cfg lint to allow (Tobin C. Harding)

Pull request description:

  Remove the `doc_auto_cfg` as we did in #5162. Shoosh the Rust compiler (not clippy). Then bump the version number, add a changelog entry, and update the lock files.


ACKs for top commit:
  apoelstra:
    ACK 125585f; successfully ran local tests; with runDocs turned off


Tree-SHA512: 8891debbef4147f3a91b941fb83a8cc9ba3a61527133c765a82f5c067866c87e778758c23a54b762a0c21c946d4727919f3fe9bcdfcdb7a19c488f4f4c2210ea
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

C-addresses PRs modifying the addresses crate C-base58 PRs modifying the base58 crate C-bitcoin PRs modifying the bitcoin crate C-chacha20_poly1305 PRs modifying the chacha20_poly1305 crate C-consensus_encoding PRs modifying the consensus-encoding crate C-hashes PRs modifying the hashes crate C-internals PRs modifying the internals crate C-io PRs modifying the io crate C-p2p C-primitives C-units PRs modifying the units crate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

consensus_encoding: docs don't build

3 participants