Skip to content

Commit

Permalink
Merge rust-bitcoin#3819: hashes: Hide both macros
Browse files Browse the repository at this point in the history
87293df api: Run just check-api (Tobin C. Harding)
ed387e5 hashes: Hide both macros (Tobin C. Harding)

Pull request description:

  We have two macro definitions feature gated on `serde`. At some stage we added the `doc(hidden)` attribute to one of them but forgot to add it to the other. This technically makes our features non-additive. This macro is "internal" so its unlikely that this is being used in the wild.

  Add `doc(hidden)` to the `serde_impl` macro that is missing it.

  Found by `cargo semver-checks` after recent upgrade to 0.38

ACKs for top commit:
  storopoli:
    ACK 87293df
  apoelstra:
    ACK 87293df; successfully ran local tests

Tree-SHA512: 3773eb42684bce56928f2d3f87993d010dd36634fda8dfa6b18b27a36b6c4bb521d711340a4868270dbd2d0c6a11715f9a1998ff3deb6900bd4227a44722a11e
  • Loading branch information
apoelstra committed Dec 29, 2024
2 parents b2a2e8e + 87293df commit 148b8b1
Show file tree
Hide file tree
Showing 3 changed files with 1 addition and 2 deletions.
1 change: 0 additions & 1 deletion api/hashes/alloc-only.txt
Original file line number Diff line number Diff line change
Expand Up @@ -859,7 +859,6 @@ pub fn bitcoin_hashes::siphash24::State::fmt(&self, f: &mut core::fmt::Formatter
pub macro bitcoin_hashes::hash_newtype!
pub macro bitcoin_hashes::impl_debug_only_for_newtype!
pub macro bitcoin_hashes::impl_hex_for_newtype!
pub macro bitcoin_hashes::serde_impl!
pub macro bitcoin_hashes::sha256t_hash_newtype!
pub macro bitcoin_hashes::sha256t_tag!
pub mod bitcoin_hashes
Expand Down
1 change: 0 additions & 1 deletion api/hashes/no-features.txt
Original file line number Diff line number Diff line change
Expand Up @@ -806,7 +806,6 @@ pub fn bitcoin_hashes::siphash24::State::clone(&self) -> bitcoin_hashes::siphash
pub fn bitcoin_hashes::siphash24::State::fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result
pub macro bitcoin_hashes::hash_newtype!
pub macro bitcoin_hashes::impl_debug_only_for_newtype!
pub macro bitcoin_hashes::serde_impl!
pub macro bitcoin_hashes::sha256t_hash_newtype!
pub macro bitcoin_hashes::sha256t_tag!
pub mod bitcoin_hashes
Expand Down
1 change: 1 addition & 0 deletions hashes/src/macros.rs
Original file line number Diff line number Diff line change
Expand Up @@ -533,6 +533,7 @@ macro_rules! serde_impl(
));

/// Does an "empty" serde implementation for the configuration without serde feature.
#[doc(hidden)]
#[macro_export]
#[cfg(not(feature = "serde"))]
macro_rules! serde_impl(
Expand Down

0 comments on commit 148b8b1

Please sign in to comment.