user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Replace cfg(dox) with cfg(doc) (#920)

Browse source 
`dox` has to be set explicitly, but `doc` is set whenever rustdoc runs.
This simplifies the doc process to `cargo doc` and means bootstrap can
stop passing `--cfg dox` when documenting crates.
This commit is contained in:
Joshua Nelson 2020-09-29 18:57:19 -04:00 • committed by GitHub
parent eba81a5a50
commit 7f7ca407ff
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 27 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

3
library/stdarch/crates/core_arch/Cargo.toml
View file

@ -25,6 +25,3 @@ maintenance = { status = "experimental" }
[dev-dependencies]
stdarch-test = { version = "0.*", path = "../stdarch-test" }
std_detect = { version = "0.*", path = "../std_detect" }
[package.metadata.docs.rs]
rustdoc-args = [ "--cfg", "dox" ]

4
library/stdarch/crates/core_arch/src/arm/mod.rs
View file

@ -19,9 +19,9 @@ mod v7;
#[cfg(any(target_arch = "aarch64", target_feature = "v7"))]
pub use self::v7::*;
#[cfg(any(target_arch = "aarch64", target_feature = "v7", dox))]
#[cfg(any(target_arch = "aarch64", target_feature = "v7", doc))]
mod neon;
#[cfg(any(target_arch = "aarch64", target_feature = "v7", dox))]
#[cfg(any(target_arch = "aarch64", target_feature = "v7", doc))]
pub use self::neon::*;
#[cfg(any(target_arch = "aarch64", target_feature = "v7"))]

4
library/stdarch/crates/core_arch/src/core_arch_docs.md
View file

@ -210,9 +210,9 @@ using LLVM's auto-vectorization to produce optimized vectorized code for
AVX2 and also for the default platform.
```rust
# #![cfg_attr(not(dox),feature(stdsimd))]
# #![cfg_attr(not(doc),feature(stdsimd))]
# #[allow(unused_imports)]
# #[cfg(not(dox))]
# #[cfg(not(doc))]
# #[macro_use(is_x86_feature_detected)]
# extern crate std_detect;

40
library/stdarch/crates/core_arch/src/mod.rs
View file

@ -3,7 +3,7 @@
#[macro_use]
mod macros;
#[cfg(any(target_arch = "arm", target_arch = "aarch64", dox))]
#[cfg(any(target_arch = "arm", target_arch = "aarch64", doc))]
mod acle;
mod simd;
@ -14,7 +14,7 @@ pub mod arch {
/// Platform-specific intrinsics for the `x86` platform.
///
/// See the [module documentation](../index.html) for more details.
#[cfg(any(target_arch = "x86", dox))]
#[cfg(any(target_arch = "x86", doc))]
#[doc(cfg(target_arch = "x86"))]
#[stable(feature = "simd_x86", since = "1.27.0")]
pub mod x86 {
@ -25,7 +25,7 @@ pub mod arch {
/// Platform-specific intrinsics for the `x86_64` platform.
///
/// See the [module documentation](../index.html) for more details.
#[cfg(any(target_arch = "x86_64", dox))]
#[cfg(any(target_arch = "x86_64", doc))]
#[doc(cfg(target_arch = "x86_64"))]
#[stable(feature = "simd_x86", since = "1.27.0")]
pub mod x86_64 {
@ -38,7 +38,7 @@ pub mod arch {
/// Platform-specific intrinsics for the `arm` platform.
///
/// See the [module documentation](../index.html) for more details.
#[cfg(any(target_arch = "arm", dox))]
#[cfg(any(target_arch = "arm", doc))]
#[doc(cfg(target_arch = "arm"))]
#[unstable(feature = "stdsimd", issue = "27731")]
pub mod arm {
@ -48,7 +48,7 @@ pub mod arch {
/// Platform-specific intrinsics for the `aarch64` platform.
///
/// See the [module documentation](../index.html) for more details.
#[cfg(any(target_arch = "aarch64", dox))]
#[cfg(any(target_arch = "aarch64", doc))]
#[doc(cfg(target_arch = "aarch64"))]
#[unstable(feature = "stdsimd", issue = "27731")]
pub mod aarch64 {
@ -161,7 +161,7 @@ pub mod arch {
/// > `-Ctarget-feature=+simd128,+unimplemented-simd128`. This second
/// > feature enables more recent instructions implemented in LLVM which
/// > haven't always had enough time to make their way to runtimes.
#[cfg(any(target_arch = "wasm32", dox))]
#[cfg(any(target_arch = "wasm32", doc))]
#[doc(cfg(target_arch = "wasm32"))]
#[stable(feature = "simd_wasm32", since = "1.33.0")]
pub mod wasm32 {
@ -172,7 +172,7 @@ pub mod arch {
/// Platform-specific intrinsics for the `mips` platform.
///
/// See the [module documentation](../index.html) for more details.
#[cfg(any(target_arch = "mips", dox))]
#[cfg(any(target_arch = "mips", doc))]
#[doc(cfg(target_arch = "mips"))]
#[unstable(feature = "stdsimd", issue = "27731")]
pub mod mips {
@ -182,7 +182,7 @@ pub mod arch {
/// Platform-specific intrinsics for the `mips64` platform.
///
/// See the [module documentation](../index.html) for more details.
#[cfg(any(target_arch = "mips64", dox))]
#[cfg(any(target_arch = "mips64", doc))]
#[doc(cfg(target_arch = "mips64"))]
#[unstable(feature = "stdsimd", issue = "27731")]
pub mod mips64 {
@ -192,7 +192,7 @@ pub mod arch {
/// Platform-specific intrinsics for the `PowerPC` platform.
///
/// See the [module documentation](../index.html) for more details.
#[cfg(any(target_arch = "powerpc", dox))]
#[cfg(any(target_arch = "powerpc", doc))]
#[doc(cfg(target_arch = "powerpc"))]
#[unstable(feature = "stdsimd", issue = "27731")]
pub mod powerpc {
@ -202,7 +202,7 @@ pub mod arch {
/// Platform-specific intrinsics for the `PowerPC64` platform.
///
/// See the [module documentation](../index.html) for more details.
#[cfg(any(target_arch = "powerpc64", dox))]
#[cfg(any(target_arch = "powerpc64", doc))]
#[doc(cfg(target_arch = "powerpc64"))]
#[unstable(feature = "stdsimd", issue = "27731")]
pub mod powerpc64 {
@ -212,7 +212,7 @@ pub mod arch {
/// Platform-specific intrinsics for the `NVPTX` platform.
///
/// See the [module documentation](../index.html) for more details.
#[cfg(any(target_arch = "nvptx", target_arch = "nvptx64", dox))]
#[cfg(any(target_arch = "nvptx", target_arch = "nvptx64", doc))]
#[doc(cfg(any(target_arch = "nvptx", target_arch = "nvptx64")))]
#[unstable(feature = "stdsimd", issue = "27731")]
pub mod nvptx {
@ -222,36 +222,36 @@ pub mod arch {
mod simd_llvm;
#[cfg(any(target_arch = "x86", target_arch = "x86_64", dox))]
#[cfg(any(target_arch = "x86", target_arch = "x86_64", doc))]
#[doc(cfg(any(target_arch = "x86", target_arch = "x86_64")))]
mod x86;
#[cfg(any(target_arch = "x86_64", dox))]
#[cfg(any(target_arch = "x86_64", doc))]
#[doc(cfg(target_arch = "x86_64"))]
mod x86_64;
#[cfg(any(target_arch = "aarch64", dox))]
#[cfg(any(target_arch = "aarch64", doc))]
#[doc(cfg(target_arch = "aarch64"))]
mod aarch64;
#[cfg(any(target_arch = "arm", target_arch = "aarch64", dox))]
#[cfg(any(target_arch = "arm", target_arch = "aarch64", doc))]
#[doc(cfg(any(target_arch = "arm", target_arch = "aarch64")))]
mod arm;
#[cfg(any(target_arch = "wasm32", dox))]
#[cfg(any(target_arch = "wasm32", doc))]
#[doc(cfg(target_arch = "wasm32"))]
mod wasm32;
#[cfg(any(target_arch = "mips", target_arch = "mips64", dox))]
#[cfg(any(target_arch = "mips", target_arch = "mips64", doc))]
#[doc(cfg(any(target_arch = "mips", target_arch = "mips64")))]
mod mips;
#[cfg(any(target_arch = "powerpc", target_arch = "powerpc64", dox))]
#[cfg(any(target_arch = "powerpc", target_arch = "powerpc64", doc))]
#[doc(cfg(any(target_arch = "powerpc", target_arch = "powerpc64")))]
mod powerpc;
#[cfg(any(target_arch = "powerpc64", dox))]
#[cfg(any(target_arch = "powerpc64", doc))]
#[doc(cfg(target_arch = "powerpc64"))]
mod powerpc64;
#[cfg(any(target_arch = "nvptx", target_arch = "nvptx64", dox))]
#[cfg(any(target_arch = "nvptx", target_arch = "nvptx64", doc))]
#[doc(cfg(any(target_arch = "nvptx", target_arch = "nvptx64")))]
mod nvptx;

2
library/stdarch/crates/core_arch/src/wasm32/atomic.rs
View file

@ -6,7 +6,7 @@
//!
//! [spec]: https://github.com/WebAssembly/threads
#![cfg(any(target_feature = "atomics", dox))]
#![cfg(any(target_feature = "atomics", doc))]
#[cfg(test)]
use stdarch_test::assert_instr;

4
library/stdarch/crates/core_arch/src/wasm32/mod.rs
View file

@ -3,9 +3,9 @@
#[cfg(test)]
use stdarch_test::assert_instr;
#[cfg(any(target_feature = "atomics", dox))]
#[cfg(any(target_feature = "atomics", doc))]
mod atomic;
#[cfg(any(target_feature = "atomics", dox))]
#[cfg(any(target_feature = "atomics", doc))]
pub use self::atomic::*;
mod simd128;