From e7a0f1ce1b6136daa03aa9154463ba645f0a1294 Mon Sep 17 00:00:00 2001 From: Denis Varlakov Date: Mon, 5 Feb 2024 09:53:41 +0000 Subject: [PATCH] Move cggmp21/docs/* to docs/* --- cggmp21-keygen/src/lib.rs | 4 ++-- cggmp21/src/key_refresh.rs | 4 ++-- cggmp21/src/key_share.rs | 8 ++++---- cggmp21/src/signing.rs | 4 ++-- {cggmp21/docs => docs}/README.md | 0 {cggmp21/docs => docs}/enforce_reliable_broadcast.md | 0 {cggmp21/docs => docs}/incomplete_key_share.md | 0 {cggmp21/docs => docs}/key_share.md | 0 {cggmp21/docs => docs}/mpc_message.md | 0 {cggmp21/docs => docs}/validated_key_share_disclaimer.md | 0 {cggmp21/docs => docs}/validated_key_share_note.md | 0 11 files changed, 10 insertions(+), 10 deletions(-) rename {cggmp21/docs => docs}/README.md (100%) rename {cggmp21/docs => docs}/enforce_reliable_broadcast.md (100%) rename {cggmp21/docs => docs}/incomplete_key_share.md (100%) rename {cggmp21/docs => docs}/key_share.md (100%) rename {cggmp21/docs => docs}/mpc_message.md (100%) rename {cggmp21/docs => docs}/validated_key_share_disclaimer.md (100%) rename {cggmp21/docs => docs}/validated_key_share_note.md (100%) diff --git a/cggmp21-keygen/src/lib.rs b/cggmp21-keygen/src/lib.rs index 99aa518..b23a4fe 100644 --- a/cggmp21-keygen/src/lib.rs +++ b/cggmp21-keygen/src/lib.rs @@ -40,7 +40,7 @@ mod default_choice { pub type SecurityLevel = crate::security_level::SecurityLevel128; } -#[doc = include_str!("../../cggmp21/docs/mpc_message.md")] +#[doc = include_str!("../../docs/mpc_message.md")] pub mod msg { /// Messages types related to non threshold DKG protocol pub mod non_threshold { @@ -178,7 +178,7 @@ where self } - #[doc = include_str!("../../cggmp21/docs/enforce_reliable_broadcast.md")] + #[doc = include_str!("../../docs/enforce_reliable_broadcast.md")] pub fn enforce_reliable_broadcast(self, enforce: bool) -> Self { Self { reliable_broadcast_enforced: enforce, diff --git a/cggmp21/src/key_refresh.rs b/cggmp21/src/key_refresh.rs index fed1edd..93b50f5 100644 --- a/cggmp21/src/key_refresh.rs +++ b/cggmp21/src/key_refresh.rs @@ -24,7 +24,7 @@ use crate::{fast_paillier, rug::Integer}; #[doc(no_inline)] pub use self::msg::{aux_only::Msg as AuxOnlyMsg, non_threshold::Msg as NonThresholdMsg}; -#[doc = include_str!("../docs/mpc_message.md")] +#[doc = include_str!("../../docs/mpc_message.md")] pub mod msg { /// Messages types related to aux information generation protocol pub mod aux_only { @@ -248,7 +248,7 @@ where self } - #[doc = include_str!("../docs/enforce_reliable_broadcast.md")] + #[doc = include_str!("../../docs/enforce_reliable_broadcast.md")] pub fn enforce_reliable_broadcast(self, v: bool) -> Self { Self { enforce_reliable_broadcast: v, diff --git a/cggmp21/src/key_share.rs b/cggmp21/src/key_share.rs index 37ad45f..5a86662 100644 --- a/cggmp21/src/key_share.rs +++ b/cggmp21/src/key_share.rs @@ -21,10 +21,10 @@ pub use cggmp21_keygen::key_share::{ /// Key share /// -#[doc = include_str!("../docs/key_share.md")] +#[doc = include_str!("../../docs/key_share.md")] /// -#[doc = include_str!("../docs/validated_key_share_note.md")] -#[doc = include_str!("../docs/validated_key_share_disclaimer.md")] +#[doc = include_str!("../../docs/validated_key_share_note.md")] +#[doc = include_str!("../../docs/validated_key_share_disclaimer.md")] pub type KeyShare = Valid>; /// Auxiliary information @@ -49,7 +49,7 @@ pub struct DirtyAuxInfo /// Dirty (unvalidated) key share /// -#[doc = include_str!("../docs/key_share.md")] +#[doc = include_str!("../../docs/key_share.md")] #[derive(Clone, Serialize, Deserialize)] #[serde(bound = "")] pub struct DirtyKeyShare { diff --git a/cggmp21/src/signing.rs b/cggmp21/src/signing.rs index 52c8049..9473705 100644 --- a/cggmp21/src/signing.rs +++ b/cggmp21/src/signing.rs @@ -105,7 +105,7 @@ pub struct Signature { pub s: NonZero>, } -#[doc = include_str!("../docs/mpc_message.md")] +#[doc = include_str!("../../docs/mpc_message.md")] pub mod msg { use digest::Digest; use generic_ec::Curve; @@ -283,7 +283,7 @@ where self } - #[doc = include_str!("../docs/enforce_reliable_broadcast.md")] + #[doc = include_str!("../../docs/enforce_reliable_broadcast.md")] pub fn enforce_reliable_broadcast(self, v: bool) -> Self { Self { enforce_reliable_broadcast: v, diff --git a/cggmp21/docs/README.md b/docs/README.md similarity index 100% rename from cggmp21/docs/README.md rename to docs/README.md diff --git a/cggmp21/docs/enforce_reliable_broadcast.md b/docs/enforce_reliable_broadcast.md similarity index 100% rename from cggmp21/docs/enforce_reliable_broadcast.md rename to docs/enforce_reliable_broadcast.md diff --git a/cggmp21/docs/incomplete_key_share.md b/docs/incomplete_key_share.md similarity index 100% rename from cggmp21/docs/incomplete_key_share.md rename to docs/incomplete_key_share.md diff --git a/cggmp21/docs/key_share.md b/docs/key_share.md similarity index 100% rename from cggmp21/docs/key_share.md rename to docs/key_share.md diff --git a/cggmp21/docs/mpc_message.md b/docs/mpc_message.md similarity index 100% rename from cggmp21/docs/mpc_message.md rename to docs/mpc_message.md diff --git a/cggmp21/docs/validated_key_share_disclaimer.md b/docs/validated_key_share_disclaimer.md similarity index 100% rename from cggmp21/docs/validated_key_share_disclaimer.md rename to docs/validated_key_share_disclaimer.md diff --git a/cggmp21/docs/validated_key_share_note.md b/docs/validated_key_share_note.md similarity index 100% rename from cggmp21/docs/validated_key_share_note.md rename to docs/validated_key_share_note.md