Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

PVF: Add missing crate descriptions #7587

Merged
merged 3 commits into from
Aug 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions node/core/candidate-validation/Cargo.toml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions node/core/pvf-checker/Cargo.toml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions node/core/pvf/Cargo.toml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions node/core/pvf/common/Cargo.toml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion node/core/pvf/common/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
1 change: 1 addition & 0 deletions node/core/pvf/execute-worker/Cargo.toml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions node/core/pvf/execute-worker/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions node/core/pvf/prepare-worker/Cargo.toml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions node/core/pvf/prepare-worker/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down
2 changes: 1 addition & 1 deletion node/core/pvf/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down