PVF: Add missing crate descriptions

paritytech · Aug 7, 2023 · e07d12e · e07d12e
1 parent c7f58c1
commit e07d12e
Show file tree

Hide file tree

Showing 9 changed files with 11 additions and 2 deletions.
diff --git a/node/core/pvf-checker/Cargo.toml b/node/core/pvf-checker/Cargo.toml
@@ -1,5 +1,6 @@
 [package]
 name = "polkadot-node-core-pvf-checker"
+description = "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/node/core/pvf/Cargo.toml b/node/core/pvf/Cargo.toml
@@ -1,5 +1,6 @@
 [package]
 name = "polkadot-node-core-pvf"
+description = "The PVF validation host. Responsible for coordinating preparation and execution of PVFs."
 version.workspace = true
 authors.workspace = true
 edition.workspace = true

diff --git a/node/core/pvf/common/Cargo.toml b/node/core/pvf/common/Cargo.toml
@@ -1,5 +1,6 @@
 [package]
 name = "polkadot-node-core-pvf-common"
+description = "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/node/core/pvf/common/src/lib.rs b/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/node/core/pvf/execute-worker/Cargo.toml b/node/core/pvf/execute-worker/Cargo.toml
@@ -1,5 +1,6 @@
 [package]
 name = "polkadot-node-core-pvf-execute-worker"
+description = "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/node/core/pvf/execute-worker/src/lib.rs b/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/node/core/pvf/prepare-worker/Cargo.toml b/node/core/pvf/prepare-worker/Cargo.toml
@@ -1,5 +1,6 @@
 [package]
 name = "polkadot-node-core-pvf-prepare-worker"
+description = "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/node/core/pvf/prepare-worker/src/lib.rs b/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/node/core/pvf/src/lib.rs b/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