diff --git a/polkadot/node/core/candidate-validation/Cargo.toml b/polkadot/node/core/candidate-validation/Cargo.toml index ba40fea8140bf629282e2cf3ae43eb30e85f23b2..0401c892d426f8da46496b8622613f7c791ed183 100644 --- a/polkadot/node/core/candidate-validation/Cargo.toml +++ b/polkadot/node/core/candidate-validation/Cargo.toml @@ -1,5 +1,6 @@ [package] name = "polkadot-node-core-candidate-validation" +description = "Polkadot crate that implements the Candidate Validation subsystem. Handles requests to validate candidates according to a PVF." version.workspace = true authors.workspace = true edition.workspace = true diff --git a/polkadot/node/core/pvf-checker/Cargo.toml b/polkadot/node/core/pvf-checker/Cargo.toml index ee7001524265ed3df5b8e5b42a54f50f9be79f90..2b6b53be407240b13d3de1c9145607e69d76b421 100644 --- a/polkadot/node/core/pvf-checker/Cargo.toml +++ b/polkadot/node/core/pvf-checker/Cargo.toml @@ -1,5 +1,6 @@ [package] name = "polkadot-node-core-pvf-checker" +description = "Polkadot crate that implements the PVF pre-checking subsystem. Responsible for checking and voting for PVFs that are pending approval." version.workspace = true authors.workspace = true edition.workspace = true diff --git a/polkadot/node/core/pvf/Cargo.toml b/polkadot/node/core/pvf/Cargo.toml index d6e9ef5766289e64fddaca4b8721af1f44180071..02a56ed9d2df55e9d037d26eddc0c0da0c285193 100644 --- a/polkadot/node/core/pvf/Cargo.toml +++ b/polkadot/node/core/pvf/Cargo.toml @@ -1,5 +1,6 @@ [package] name = "polkadot-node-core-pvf" +description = "Polkadot crate that implements the PVF validation host. Responsible for coordinating preparation and execution of PVFs." version.workspace = true authors.workspace = true edition.workspace = true diff --git a/polkadot/node/core/pvf/common/Cargo.toml b/polkadot/node/core/pvf/common/Cargo.toml index 3e674422f8123e7be99dbe80ffcadeaed58025da..a091f8f7580685113054da9dcd6c4f26453c3510 100644 --- a/polkadot/node/core/pvf/common/Cargo.toml +++ b/polkadot/node/core/pvf/common/Cargo.toml @@ -1,5 +1,6 @@ [package] name = "polkadot-node-core-pvf-common" +description = "Polkadot crate that contains functionality related to PVFs that is shared by the PVF host and the PVF workers." version.workspace = true authors.workspace = true edition.workspace = true diff --git a/polkadot/node/core/pvf/common/src/lib.rs b/polkadot/node/core/pvf/common/src/lib.rs index e5737a66aaec20ea2b08283d86f18aff92b26787..7e0cab45b671eb0444a6b157a15760d88fd9378e 100644 --- a/polkadot/node/core/pvf/common/src/lib.rs +++ b/polkadot/node/core/pvf/common/src/lib.rs @@ -14,7 +14,7 @@ // You should have received a copy of the GNU General Public License // along with Polkadot. If not, see <http://www.gnu.org/licenses/>. -//! Functionality that is shared by the host and the workers. +//! Contains functionality related to PVFs that is shared by the PVF host and the PVF workers. pub mod error; pub mod execute; diff --git a/polkadot/node/core/pvf/execute-worker/Cargo.toml b/polkadot/node/core/pvf/execute-worker/Cargo.toml index 1c9e2d1f2784950e616d72f80f4486f047705ea3..931ea6951a68a920660136173c028dad6a39b5d0 100644 --- a/polkadot/node/core/pvf/execute-worker/Cargo.toml +++ b/polkadot/node/core/pvf/execute-worker/Cargo.toml @@ -1,5 +1,6 @@ [package] name = "polkadot-node-core-pvf-execute-worker" +description = "Polkadot crate that contains the logic for executing PVFs. Used by the polkadot-execute-worker binary." version.workspace = true authors.workspace = true edition.workspace = true diff --git a/polkadot/node/core/pvf/execute-worker/src/lib.rs b/polkadot/node/core/pvf/execute-worker/src/lib.rs index d90cac2522fd838b4fc7ffca55f360ae1b93774b..c6ee515f90938147eec496471b67422211d99e1e 100644 --- a/polkadot/node/core/pvf/execute-worker/src/lib.rs +++ b/polkadot/node/core/pvf/execute-worker/src/lib.rs @@ -14,6 +14,8 @@ // You should have received a copy of the GNU General Public License // along with Polkadot. If not, see <http://www.gnu.org/licenses/>. +//! Contains the logic for executing PVFs. Used by the polkadot-execute-worker binary. + pub use polkadot_node_core_pvf_common::executor_intf::Executor; // NOTE: Initializing logging in e.g. tests will not have an effect in the workers, as they are diff --git a/polkadot/node/core/pvf/prepare-worker/Cargo.toml b/polkadot/node/core/pvf/prepare-worker/Cargo.toml index 2f18faac712c8cdaf4b1e5d813b50b1e77461a08..9ee009de44bb95f9da22f4e146bc2ca497967caf 100644 --- a/polkadot/node/core/pvf/prepare-worker/Cargo.toml +++ b/polkadot/node/core/pvf/prepare-worker/Cargo.toml @@ -1,5 +1,6 @@ [package] name = "polkadot-node-core-pvf-prepare-worker" +description = "Polkadot crate that contains the logic for preparing PVFs. Used by the polkadot-prepare-worker binary." version.workspace = true authors.workspace = true edition.workspace = true diff --git a/polkadot/node/core/pvf/prepare-worker/src/lib.rs b/polkadot/node/core/pvf/prepare-worker/src/lib.rs index 228ad3d4668d24d8df783674d598480bb63bcb2e..3f60163c61960df5b2f5ae73a8b6654ee5c234e0 100644 --- a/polkadot/node/core/pvf/prepare-worker/src/lib.rs +++ b/polkadot/node/core/pvf/prepare-worker/src/lib.rs @@ -14,6 +14,8 @@ // You should have received a copy of the GNU General Public License // along with Polkadot. If not, see <http://www.gnu.org/licenses/>. +//! Contains the logic for preparing PVFs. Used by the polkadot-prepare-worker binary. + mod executor_intf; mod memory_stats; diff --git a/polkadot/node/core/pvf/src/lib.rs b/polkadot/node/core/pvf/src/lib.rs index 772c0b430c1b8997a72632ef2ec22003c0f5fbf8..2ed3f5242deddddfd4130f932857d1d0cf332349 100644 --- a/polkadot/node/core/pvf/src/lib.rs +++ b/polkadot/node/core/pvf/src/lib.rs @@ -16,7 +16,7 @@ #![warn(missing_docs)] -//! A crate that implements the PVF validation host. +//! The PVF validation host. Responsible for coordinating preparation and execution of PVFs. //! //! For more background, refer to the Implementer's Guide: [PVF //! Pre-checking](https://paritytech.github.io/polkadot/book/pvf-prechecking.html) and [Candidate