saymrwulf/curve25519-dalek-source
1
0
Fork 0
mirror of https://github.com/saymrwulf/curve25519-dalek-source.git synced 2026-09-04 20:24:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Attempt to fix cfg(rustdoc) on docs.rs

Browse source 
Building the docs currently doesn't work, because rustdoc enables parts of the
code (to document them) which then don't check (because there are missing
exports or dependencies).  This **should** fix the issue, but there's no way to
test without publishing a new version.
This commit is contained in:
Henry de Valence 2019-02-15 11:18:25 -08:00
parent 77b4c7b30d
commit b8c62ec4b4
2 changed files with 10 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Cargo.toml
View file

@ -20,7 +20,7 @@ build = "build.rs"
[package.metadata.docs.rs] [package.metadata.docs.rs]
rustdoc-args = ["--html-in-header", ".cargo/registry/src/github.com-1ecc6299db9ec823/curve25519-dalek-0.13.2/rustdoc-include-katex-header.html"] rustdoc-args = ["--html-in-header", ".cargo/registry/src/github.com-1ecc6299db9ec823/curve25519-dalek-0.13.2/rustdoc-include-katex-header.html"]
features = ["nightly"] features = ["nightly", "simd_backend"]
[badges] [badges]
travis-ci = { repository = "dalek-cryptography/curve25519-dalek", branch = "master"} travis-ci = { repository = "dalek-cryptography/curve25519-dalek", branch = "master"}

12
src/backend/vector/mod.rs
View file

@ -22,13 +22,19 @@
doc(include = "../docs/parallel-formulas.md") doc(include = "../docs/parallel-formulas.md")
)] )]
#[cfg(not(any(target_feature = "avx2", target_feature = "avx512ifma",)))] #[cfg(not(any(target_feature = "avx2", target_feature = "avx512ifma", rustdoc)))]
compile_error!("simd_backend selected without target_feature=+avx2 or +avx512ifma"); compile_error!("simd_backend selected without target_feature=+avx2 or +avx512ifma");
#[cfg(any(all(target_feature = "avx2", not(target_feature = "avx512ifma")), rustdoc))] #[cfg(any(
all(target_feature = "avx2", not(target_feature = "avx512ifma")),
rustdoc
))]
#[doc(cfg(all(target_feature = "avx2", not(target_feature = "avx512ifma"))))] #[doc(cfg(all(target_feature = "avx2", not(target_feature = "avx512ifma"))))]
pub mod avx2; pub mod avx2;
#[cfg(all(target_feature = "avx2", not(target_feature = "avx512ifma")))] #[cfg(any(
all(target_feature = "avx2", not(target_feature = "avx512ifma")),
rustdoc
))]
pub(crate) use self::avx2::{ pub(crate) use self::avx2::{
constants::BASEPOINT_ODD_LOOKUP_TABLE, edwards::CachedPoint, edwards::ExtendedPoint, constants::BASEPOINT_ODD_LOOKUP_TABLE, edwards::CachedPoint, edwards::ExtendedPoint,
}; };