From ffb742310f1148e7dbda4088f0c45fdb986b0587 Mon Sep 17 00:00:00 2001 From: Marcin S <marcin@realemail.net> Date: Tue, 8 Aug 2023 09:51:40 -0400 Subject: [PATCH] PVF: Add missing crate descriptions (#7587) --- polkadot/node/core/candidate-validation/Cargo.toml | 1 + polkadot/node/core/pvf-checker/Cargo.toml | 1 + polkadot/node/core/pvf/Cargo.toml | 1 + polkadot/node/core/pvf/common/Cargo.toml | 1 + polkadot/node/core/pvf/common/src/lib.rs | 2 +- polkadot/node/core/pvf/execute-worker/Cargo.toml | 1 + polkadot/node/core/pvf/execute-worker/src/lib.rs | 2 ++ polkadot/node/core/pvf/prepare-worker/Cargo.toml | 1 + polkadot/node/core/pvf/prepare-worker/src/lib.rs | 2 ++ polkadot/node/core/pvf/src/lib.rs | 2 +- 10 files changed, 12 insertions(+), 2 deletions(-) diff --git a/polkadot/node/core/candidate-validation/Cargo.toml b/polkadot/node/core/candidate-validation/Cargo.toml index ba40fea8140..0401c892d42 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 ee700152426..2b6b53be407 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 d6e9ef57662..02a56ed9d2d 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 3e674422f81..a091f8f7580 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 e5737a66aae..7e0cab45b67 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 1c9e2d1f278..931ea6951a6 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 d90cac2522f..c6ee515f909 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 2f18faac712..9ee009de44b 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 228ad3d4668..3f60163c619 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 772c0b430c1..2ed3f5242de 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 -- GitLab