cmov: add doc(cfg(true)) to backend trait impls (#1371)

tarcieri · web-flow · commit 9985bd69d950 · 2026-01-16T20:50:30.000-07:00
This ensures that they show up as always available in the rustdoc
rendered on docs.rs, as opposed to appearing with target/feature gates
that don't actually exist
diff --git a/cmov/Cargo.toml b/cmov/Cargo.toml
@@ -18,3 +18,6 @@ instructions on x86/x86_64 and CSEL on AArch64, along with a portable "best-effo
 
 [dev-dependencies]
 proptest = "1.9"
+
+[package.metadata.docs.rs]
+all-features = true
diff --git a/cmov/src/backends/aarch64.rs b/cmov/src/backends/aarch64.rs
@@ -86,6 +86,7 @@ macro_rules! cseleq64 {
     };
 }
 
+#[cfg_attr(docsrs, doc(cfg(true)))]
 impl Cmov for u16 {
     #[inline]
     fn cmovnz(&mut self, value: &Self, condition: Condition) {
@@ -98,6 +99,7 @@ impl Cmov for u16 {
     }
 }
 
+#[cfg_attr(docsrs, doc(cfg(true)))]
 impl Cmov for u32 {
     #[inline]
     fn cmovnz(&mut self, value: &Self, condition: Condition) {
@@ -110,6 +112,7 @@ impl Cmov for u32 {
     }
 }
 
+#[cfg_attr(docsrs, doc(cfg(true)))]
 impl Cmov for u64 {
     #[inline]
     fn cmovnz(&mut self, value: &Self, condition: Condition) {
@@ -122,6 +125,7 @@ impl Cmov for u64 {
     }
 }
 
+#[cfg_attr(docsrs, doc(cfg(true)))]
 impl CmovEq for u16 {
     #[inline]
     fn cmovne(&self, rhs: &Self, input: Condition, output: &mut Condition) {
@@ -134,6 +138,7 @@ impl CmovEq for u16 {
     }
 }
 
+#[cfg_attr(docsrs, doc(cfg(true)))]
 impl CmovEq for u32 {
     #[inline]
     fn cmovne(&self, rhs: &Self, input: Condition, output: &mut Condition) {
@@ -146,6 +151,7 @@ impl CmovEq for u32 {
     }
 }
 
+#[cfg_attr(docsrs, doc(cfg(true)))]
 impl CmovEq for u64 {
     #[inline]
     fn cmovne(&self, rhs: &Self, input: Condition, output: &mut Condition) {
diff --git a/cmov/src/backends/soft.rs b/cmov/src/backends/soft.rs
@@ -11,6 +11,7 @@
 use crate::{Cmov, CmovEq, Condition};
 use core::ops::{BitAnd, BitOr, Not};
 
+#[cfg_attr(docsrs, doc(cfg(true)))]
 impl Cmov for u16 {
     #[inline]
     fn cmovnz(&mut self, value: &u16, condition: Condition) {
@@ -23,6 +24,7 @@ impl Cmov for u16 {
     }
 }
 
+#[cfg_attr(docsrs, doc(cfg(true)))]
 impl Cmov for u32 {
     #[inline]
     fn cmovnz(&mut self, value: &Self, condition: Condition) {
@@ -35,6 +37,7 @@ impl Cmov for u32 {
     }
 }
 
+#[cfg_attr(docsrs, doc(cfg(true)))]
 impl Cmov for u64 {
     #[inline]
     fn cmovnz(&mut self, value: &Self, condition: Condition) {
@@ -47,6 +50,7 @@ impl Cmov for u64 {
     }
 }
 
+#[cfg_attr(docsrs, doc(cfg(true)))]
 impl CmovEq for u16 {
     #[inline]
     fn cmovne(&self, rhs: &Self, input: Condition, output: &mut Condition) {
@@ -67,6 +71,7 @@ impl CmovEq for u16 {
     }
 }
 
+#[cfg_attr(docsrs, doc(cfg(true)))]
 impl CmovEq for u32 {
     #[inline]
     fn cmovne(&self, rhs: &Self, input: Condition, output: &mut Condition) {
@@ -79,6 +84,7 @@ impl CmovEq for u32 {
     }
 }
 
+#[cfg_attr(docsrs, doc(cfg(true)))]
 impl CmovEq for u64 {
     #[inline]
     fn cmovne(&self, rhs: &Self, input: Condition, output: &mut Condition) {
@@ -97,31 +103,31 @@ fn maskeq32(x: u32, y: u32) -> u32 {
     !maskne32(x, y)
 }
 
-/// Returns `u32::MAX` if `x` is equal to `y`, otherwise returns `0` (64-bit version)
+/// Returns `u64::MAX` if `x` is equal to `y`, otherwise returns `0` (64-bit version)
 #[inline]
 fn maskeq64(x: u64, y: u64) -> u64 {
     !maskne64(x, y)
 }
 
-/// Returns `0` if `x` is equal to `y`, otherwise returns `1` (32-bit version)
+/// Returns `0` if `x` is equal to `y`, otherwise returns `u32::MAX` (32-bit version)
 #[inline]
 fn maskne32(x: u32, y: u32) -> u32 {
     masknz32(x ^ y)
 }
 
-/// Returns `0` if `x` is equal to `y`, otherwise returns `1` (64-bit version)
+/// Returns `0` if `x` is equal to `y`, otherwise returns `u64::MAX` (64-bit version)
 #[inline]
 fn maskne64(x: u64, y: u64) -> u64 {
     masknz64(x ^ y)
 }
 
-/// Return a [`u32::MAX`] mask if `condition` is non-zero, otherwise return zero for a zero input.
+/// Return a `u32::MAX` mask if `condition` is non-zero, otherwise return zero for a zero input.
 #[cfg(not(target_arch = "arm"))]
 fn masknz32(condition: u32) -> u32 {
     masknz!(condition: u32)
 }
 
-/// Return a [`u64::MAX`] mask if `condition` is non-zero, otherwise return zero for a zero input.
+/// Return a `u64::MAX` mask if `condition` is non-zero, otherwise return zero for a zero input.
 #[cfg(not(target_arch = "arm"))]
 fn masknz64(condition: u64) -> u64 {
     masknz!(condition: u64)
diff --git a/cmov/src/backends/x86.rs b/cmov/src/backends/x86.rs
@@ -45,6 +45,7 @@ macro_rules! cmov_eq {
     };
 }
 
+#[cfg_attr(docsrs, doc(cfg(true)))]
 impl Cmov for u16 {
     #[inline]
     fn cmovnz(&mut self, value: &Self, condition: Condition) {
@@ -57,6 +58,7 @@ impl Cmov for u16 {
     }
 }
 
+#[cfg_attr(docsrs, doc(cfg(true)))]
 impl Cmov for u32 {
     #[inline]
     fn cmovnz(&mut self, value: &Self, condition: Condition) {
@@ -70,6 +72,7 @@ impl Cmov for u32 {
 }
 
 #[cfg(target_arch = "x86")]
+#[cfg_attr(docsrs, doc(cfg(true)))]
 impl Cmov for u64 {
     #[inline]
     fn cmovnz(&mut self, value: &Self, condition: Condition) {
@@ -95,6 +98,7 @@ impl Cmov for u64 {
 }
 
 #[cfg(target_arch = "x86_64")]
+#[cfg_attr(docsrs, doc(cfg(true)))]
 impl Cmov for u64 {
     #[inline]
     fn cmovnz(&mut self, value: &Self, condition: Condition) {
@@ -107,6 +111,7 @@ impl Cmov for u64 {
     }
 }
 
+#[cfg_attr(docsrs, doc(cfg(true)))]
 impl CmovEq for u16 {
     #[inline]
     fn cmoveq(&self, rhs: &Self, input: Condition, output: &mut Condition) {
@@ -133,6 +138,7 @@ impl CmovEq for u16 {
     }
 }
 
+#[cfg_attr(docsrs, doc(cfg(true)))]
 impl CmovEq for u32 {
     #[inline]
     fn cmoveq(&self, rhs: &Self, input: Condition, output: &mut Condition) {
@@ -160,6 +166,7 @@ impl CmovEq for u32 {
 }
 
 #[cfg(target_arch = "x86")]
+#[cfg_attr(docsrs, doc(cfg(true)))]
 impl CmovEq for u64 {
     #[inline]
     fn cmovne(&self, rhs: &Self, input: Condition, output: &mut Condition) {
@@ -185,6 +192,7 @@ impl CmovEq for u64 {
 }
 
 #[cfg(target_arch = "x86_64")]
+#[cfg_attr(docsrs, doc(cfg(true)))]
 impl CmovEq for u64 {
     #[inline]
     fn cmoveq(&self, rhs: &Self, input: Condition, output: &mut Condition) {

Original file line number	Diff line number	Diff line change
`@@ -86,6 +86,7 @@ macro_rules! cseleq64 {`
`86`	`86`	`};`
`87`	`87`	`}`
`88`	`88`
	`89`	`+#[cfg_attr(docsrs, doc(cfg(true)))]`
`89`	`90`	`impl Cmov for u16 {`
`90`	`91`	`#[inline]`
`91`	`92`	`fn cmovnz(&mut self, value: &Self, condition: Condition) {`
`@@ -98,6 +99,7 @@ impl Cmov for u16 {`
`98`	`99`	`}`
`99`	`100`	`}`
`100`	`101`
	`102`	`+#[cfg_attr(docsrs, doc(cfg(true)))]`
`101`	`103`	`impl Cmov for u32 {`
`102`	`104`	`#[inline]`
`103`	`105`	`fn cmovnz(&mut self, value: &Self, condition: Condition) {`
`@@ -110,6 +112,7 @@ impl Cmov for u32 {`
`110`	`112`	`}`
`111`	`113`	`}`
`112`	`114`
	`115`	`+#[cfg_attr(docsrs, doc(cfg(true)))]`
`113`	`116`	`impl Cmov for u64 {`
`114`	`117`	`#[inline]`
`115`	`118`	`fn cmovnz(&mut self, value: &Self, condition: Condition) {`
`@@ -122,6 +125,7 @@ impl Cmov for u64 {`
`122`	`125`	`}`
`123`	`126`	`}`
`124`	`127`
	`128`	`+#[cfg_attr(docsrs, doc(cfg(true)))]`
`125`	`129`	`impl CmovEq for u16 {`
`126`	`130`	`#[inline]`
`127`	`131`	`fn cmovne(&self, rhs: &Self, input: Condition, output: &mut Condition) {`
`@@ -134,6 +138,7 @@ impl CmovEq for u16 {`
`134`	`138`	`}`
`135`	`139`	`}`
`136`	`140`
	`141`	`+#[cfg_attr(docsrs, doc(cfg(true)))]`
`137`	`142`	`impl CmovEq for u32 {`
`138`	`143`	`#[inline]`
`139`	`144`	`fn cmovne(&self, rhs: &Self, input: Condition, output: &mut Condition) {`
`@@ -146,6 +151,7 @@ impl CmovEq for u32 {`
`146`	`151`	`}`
`147`	`152`	`}`
`148`	`153`
	`154`	`+#[cfg_attr(docsrs, doc(cfg(true)))]`
`149`	`155`	`impl CmovEq for u64 {`
`150`	`156`	`#[inline]`
`151`	`157`	`fn cmovne(&self, rhs: &Self, input: Condition, output: &mut Condition) {`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@`
`11`	`11`	`use crate::{Cmov, CmovEq, Condition};`
`12`	`12`	`use core::ops::{BitAnd, BitOr, Not};`
`13`	`13`
	`14`	`+#[cfg_attr(docsrs, doc(cfg(true)))]`
`14`	`15`	`impl Cmov for u16 {`
`15`	`16`	`#[inline]`
`16`	`17`	`fn cmovnz(&mut self, value: &u16, condition: Condition) {`
`@@ -23,6 +24,7 @@ impl Cmov for u16 {`
`23`	`24`	`}`
`24`	`25`	`}`
`25`	`26`
	`27`	`+#[cfg_attr(docsrs, doc(cfg(true)))]`
`26`	`28`	`impl Cmov for u32 {`
`27`	`29`	`#[inline]`
`28`	`30`	`fn cmovnz(&mut self, value: &Self, condition: Condition) {`
`@@ -35,6 +37,7 @@ impl Cmov for u32 {`
`35`	`37`	`}`
`36`	`38`	`}`
`37`	`39`
	`40`	`+#[cfg_attr(docsrs, doc(cfg(true)))]`
`38`	`41`	`impl Cmov for u64 {`
`39`	`42`	`#[inline]`
`40`	`43`	`fn cmovnz(&mut self, value: &Self, condition: Condition) {`
`@@ -47,6 +50,7 @@ impl Cmov for u64 {`
`47`	`50`	`}`
`48`	`51`	`}`
`49`	`52`
	`53`	`+#[cfg_attr(docsrs, doc(cfg(true)))]`
`50`	`54`	`impl CmovEq for u16 {`
`51`	`55`	`#[inline]`
`52`	`56`	`fn cmovne(&self, rhs: &Self, input: Condition, output: &mut Condition) {`
`@@ -67,6 +71,7 @@ impl CmovEq for u16 {`
`67`	`71`	`}`
`68`	`72`	`}`
`69`	`73`
	`74`	`+#[cfg_attr(docsrs, doc(cfg(true)))]`
`70`	`75`	`impl CmovEq for u32 {`
`71`	`76`	`#[inline]`
`72`	`77`	`fn cmovne(&self, rhs: &Self, input: Condition, output: &mut Condition) {`
`@@ -79,6 +84,7 @@ impl CmovEq for u32 {`
`79`	`84`	`}`
`80`	`85`	`}`
`81`	`86`
	`87`	`+#[cfg_attr(docsrs, doc(cfg(true)))]`
`82`	`88`	`impl CmovEq for u64 {`
`83`	`89`	`#[inline]`
`84`	`90`	`fn cmovne(&self, rhs: &Self, input: Condition, output: &mut Condition) {`
`@@ -97,31 +103,31 @@ fn maskeq32(x: u32, y: u32) -> u32 {`
`97`	`103`	`!maskne32(x, y)`
`98`	`104`	`}`
`99`	`105`
`100`		-/// Returns `u32::MAX` if `x` is equal to `y`, otherwise returns `0` (64-bit version)
	`106`	+/// Returns `u64::MAX` if `x` is equal to `y`, otherwise returns `0` (64-bit version)
`101`	`107`	`#[inline]`
`102`	`108`	`fn maskeq64(x: u64, y: u64) -> u64 {`
`103`	`109`	`!maskne64(x, y)`
`104`	`110`	`}`
`105`	`111`
`106`		-/// Returns `0` if `x` is equal to `y`, otherwise returns `1` (32-bit version)
	`112`	+/// Returns `0` if `x` is equal to `y`, otherwise returns `u32::MAX` (32-bit version)
`107`	`113`	`#[inline]`
`108`	`114`	`fn maskne32(x: u32, y: u32) -> u32 {`
`109`	`115`	`masknz32(x ^ y)`
`110`	`116`	`}`
`111`	`117`
`112`		-/// Returns `0` if `x` is equal to `y`, otherwise returns `1` (64-bit version)
	`118`	+/// Returns `0` if `x` is equal to `y`, otherwise returns `u64::MAX` (64-bit version)
`113`	`119`	`#[inline]`
`114`	`120`	`fn maskne64(x: u64, y: u64) -> u64 {`
`115`	`121`	`masknz64(x ^ y)`
`116`	`122`	`}`
`117`	`123`
`118`		-/// Return a [`u32::MAX`] mask if `condition` is non-zero, otherwise return zero for a zero input.
	`124`	+/// Return a `u32::MAX` mask if `condition` is non-zero, otherwise return zero for a zero input.
`119`	`125`	`#[cfg(not(target_arch = "arm"))]`
`120`	`126`	`fn masknz32(condition: u32) -> u32 {`
`121`	`127`	`masknz!(condition: u32)`
`122`	`128`	`}`
`123`	`129`
`124`		-/// Return a [`u64::MAX`] mask if `condition` is non-zero, otherwise return zero for a zero input.
	`130`	+/// Return a `u64::MAX` mask if `condition` is non-zero, otherwise return zero for a zero input.
`125`	`131`	`#[cfg(not(target_arch = "arm"))]`
`126`	`132`	`fn masknz64(condition: u64) -> u64 {`
`127`	`133`	`masknz!(condition: u64)`
Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,7 @@ macro_rules! cmov_eq {`
`45`	`45`	`};`
`46`	`46`	`}`
`47`	`47`
	`48`	`+#[cfg_attr(docsrs, doc(cfg(true)))]`
`48`	`49`	`impl Cmov for u16 {`
`49`	`50`	`#[inline]`
`50`	`51`	`fn cmovnz(&mut self, value: &Self, condition: Condition) {`
`@@ -57,6 +58,7 @@ impl Cmov for u16 {`
`57`	`58`	`}`
`58`	`59`	`}`
`59`	`60`
	`61`	`+#[cfg_attr(docsrs, doc(cfg(true)))]`
`60`	`62`	`impl Cmov for u32 {`
`61`	`63`	`#[inline]`
`62`	`64`	`fn cmovnz(&mut self, value: &Self, condition: Condition) {`
`@@ -70,6 +72,7 @@ impl Cmov for u32 {`
`70`	`72`	`}`
`71`	`73`
`72`	`74`	`#[cfg(target_arch = "x86")]`
	`75`	`+#[cfg_attr(docsrs, doc(cfg(true)))]`
`73`	`76`	`impl Cmov for u64 {`
`74`	`77`	`#[inline]`
`75`	`78`	`fn cmovnz(&mut self, value: &Self, condition: Condition) {`
`@@ -95,6 +98,7 @@ impl Cmov for u64 {`
`95`	`98`	`}`
`96`	`99`
`97`	`100`	`#[cfg(target_arch = "x86_64")]`
	`101`	`+#[cfg_attr(docsrs, doc(cfg(true)))]`
`98`	`102`	`impl Cmov for u64 {`
`99`	`103`	`#[inline]`
`100`	`104`	`fn cmovnz(&mut self, value: &Self, condition: Condition) {`
`@@ -107,6 +111,7 @@ impl Cmov for u64 {`
`107`	`111`	`}`
`108`	`112`	`}`
`109`	`113`
	`114`	`+#[cfg_attr(docsrs, doc(cfg(true)))]`
`110`	`115`	`impl CmovEq for u16 {`
`111`	`116`	`#[inline]`
`112`	`117`	`fn cmoveq(&self, rhs: &Self, input: Condition, output: &mut Condition) {`
`@@ -133,6 +138,7 @@ impl CmovEq for u16 {`
`133`	`138`	`}`
`134`	`139`	`}`
`135`	`140`
	`141`	`+#[cfg_attr(docsrs, doc(cfg(true)))]`
`136`	`142`	`impl CmovEq for u32 {`
`137`	`143`	`#[inline]`
`138`	`144`	`fn cmoveq(&self, rhs: &Self, input: Condition, output: &mut Condition) {`
`@@ -160,6 +166,7 @@ impl CmovEq for u32 {`
`160`	`166`	`}`
`161`	`167`
`162`	`168`	`#[cfg(target_arch = "x86")]`
	`169`	`+#[cfg_attr(docsrs, doc(cfg(true)))]`
`163`	`170`	`impl CmovEq for u64 {`
`164`	`171`	`#[inline]`
`165`	`172`	`fn cmovne(&self, rhs: &Self, input: Condition, output: &mut Condition) {`
`@@ -185,6 +192,7 @@ impl CmovEq for u64 {`
`185`	`192`	`}`
`186`	`193`
`187`	`194`	`#[cfg(target_arch = "x86_64")]`
	`195`	`+#[cfg_attr(docsrs, doc(cfg(true)))]`
`188`	`196`	`impl CmovEq for u64 {`
`189`	`197`	`#[inline]`
`190`	`198`	`fn cmoveq(&self, rhs: &Self, input: Condition, output: &mut Condition) {`