Move cggmp21/docs/* to docs/*

LFDT-Lockness · Feb 5, 2024 · e7a0f1c · e7a0f1c
1 parent df763df
commit e7a0f1c
Show file tree

Hide file tree

Showing 11 changed files with 10 additions and 10 deletions.
diff --git 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
@@ -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
@@ -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<E, L = crate::default_choice::SecurityLevel> = Valid<DirtyKeyShare<E, L>>;
 
 /// Auxiliary information
@@ -49,7 +49,7 @@ pub struct DirtyAuxInfo<L: SecurityLevel = crate::default_choice::SecurityLevel>
 
 /// 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<E: Curve, L: SecurityLevel = crate::default_choice::SecurityLevel> {

diff --git a/cggmp21/src/signing.rs b/cggmp21/src/signing.rs
@@ -105,7 +105,7 @@ pub struct Signature<E: Curve> {
     pub s: NonZero<Scalar<E>>,
 }
 
-#[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 → docs/README.md b/cggmp21/docs/README.md → docs/README.md
diff --git a/cggmp21/docs/enforce_reliable_broadcast.md → docs/enforce_reliable_broadcast.md b/cggmp21/docs/enforce_reliable_broadcast.md → docs/enforce_reliable_broadcast.md
diff --git a/cggmp21/docs/incomplete_key_share.md → docs/incomplete_key_share.md b/cggmp21/docs/incomplete_key_share.md → docs/incomplete_key_share.md
diff --git a/cggmp21/docs/key_share.md → docs/key_share.md b/cggmp21/docs/key_share.md → docs/key_share.md
diff --git a/cggmp21/docs/mpc_message.md → docs/mpc_message.md b/cggmp21/docs/mpc_message.md → docs/mpc_message.md
diff --git a/...21/docs/validated_key_share_disclaimer.md → docs/validated_key_share_disclaimer.md b/...21/docs/validated_key_share_disclaimer.md → docs/validated_key_share_disclaimer.md
diff --git a/cggmp21/docs/validated_key_share_note.md → docs/validated_key_share_note.md b/cggmp21/docs/validated_key_share_note.md → docs/validated_key_share_note.md