WIP: CI: add spellcheck

.config/lingua.dic

@@ -1,4 +1,17 @@
 150
+fd
+PVF/S
+doesn
+hadn
+wasn
+weren
+ve
+bool
+preverify/G
+deserialize
+prevalidation
+OOM/S
+warming/S
 adversary/SM
 annualised/MS
 Apache-2.0/M

.config/spellcheck.toml

@@ -2,6 +2,8 @@
 lang = "en_US"
 search_dirs = ["."]
 extra_dictionaries = ["lingua.dic"]
+skip_os_lookups = true
+use_builtin = true
 
 [hunspell.quirks]
 # `Type`'s

file_header.txt

@@ -1,4 +1,4 @@
-// Copyright 2017-2020 Parity Technologies (UK) Ltd.
+// Copyright 2017-2021 Parity Technologies (UK) Ltd.
 // This file is part of Polkadot.
 
 // Polkadot is free software: you can redistribute it and/or modify

node/core/pvf/src/error.rs

@@ -40,7 +40,7 @@ pub enum InvalidCandidate {
 	///
 	/// (b) The candidate triggered a code path that has lead to the process death. For example,
 	///     the PVF found a way to consume unbounded amount of resources and then it either exceeded
-	///     an rlimit (if set) or, again, invited OOM killer. Another possibility is a bug in
+	///     an `rlimit` (if set) or, again, invited OOM killer. Another possibility is a bug in
 	///     wasmtime allowed the PVF to gain control over the execution worker.
 	///
 	/// We attribute such an event to an invalid candidate in either case.

node/core/pvf/src/execute/worker.rs

@@ -185,7 +185,7 @@ impl Response {
 	}
 }
 
-/// The entrypoint that the spawned execute worker should start with. The socket_path specifies
+/// The entrypoint that the spawned execute worker should start with. The `socket_path` specifies
 /// the path to the socket used to communicate with the host.
 pub fn worker_entrypoint(socket_path: &str) {
 	worker_event_loop("execute", socket_path, |mut stream| async move {

node/core/pvf/src/executor_intf.rs

@@ -38,7 +38,7 @@ const CONFIG: Config = Config {
 	},
 };
 
-/// Runs the prevaldation on the given code. Returns a [`RuntimeBlob`] if it succeeds.
+/// Runs the prevalidation on the given code. Returns a [`RuntimeBlob`] if it succeeds.
 pub fn prevalidate(code: &[u8]) -> Result<RuntimeBlob, sc_executor_common::error::WasmError> {
 	let blob = RuntimeBlob::new(code)?;
 	// It's assumed this function will take care of any prevalidation logic

node/core/pvf/src/host.rs

@@ -628,7 +628,7 @@ mod tests {
 		}
 	}
 
-	/// Creates a new pvf which artifact id can be uniquely identified by the given number.
+	/// Creates a new PVF which artifact id can be uniquely identified by the given number.
 	fn artifact_id(descriminator: u32) -> ArtifactId {
 		Pvf::from_discriminator(descriminator).as_artifact_id()
 	}

node/core/pvf/src/prepare/queue.rs

@@ -530,7 +530,7 @@ mod tests {
 	use std::task::Poll;
 	use super::*;
 
-	/// Creates a new pvf which artifact id can be uniquely identified by the given number.
+	/// Creates a new PVF which artifact id can be uniquely identified by the given number.
 	fn pvf(descriminator: u32) -> Pvf {
 		Pvf::from_discriminator(descriminator)
 	}

node/core/pvf/src/prepare/worker.rs

@@ -270,7 +270,7 @@ fn renice(pid: u32, niceness: i32) {
 	}
 }
 
-/// The entrypoint that the spawned prepare worker should start with. The socket_path specifies
+/// The entrypoint that the spawned prepare worker should start with. The `socket_path` specifies
 /// the path to the socket used to communicate with the host.
 pub fn worker_entrypoint(socket_path: &str) {
 	worker_event_loop("prepare", socket_path, |mut stream| async move {

node/core/pvf/src/pvf.rs

@@ -42,7 +42,7 @@ impl Pvf {
 		Self { code, code_hash }
 	}
 
-	/// Creates a new pvf which artifact id can be uniquely identified by the given number.
+	/// Creates a new PVF which artifact id can be uniquely identified by the given number.
 	#[cfg(test)]
 	pub(crate) fn from_discriminator(num: u32) -> Self {
 		let descriminator_buf = num.to_le_bytes().to_vec();