try-runtime: run migration checks per default (#13684)

* try-runtime: run migration checks per default

The current behaviour of having to explicetly specify --checks seems
to cause confusion. Therefore bringing back the old behaviour of
running the pre- and post-upgrade checks per default.

Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>

* Fix docs

Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>

---------

Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
This commit is contained in:
Oliver Tale-Yazdi
2023-03-24 16:09:34 +01:00
committed by GitHub
parent 2c77f8f4ca
commit c6a9b81fad
2 changed files with 7 additions and 7 deletions
@@ -40,8 +40,8 @@ pub struct OnRuntimeUpgradeCmd {
/// Performing any checks will potentially invalidate the measured PoV/Weight.
// NOTE: The clap attributes make it backwards compatible with the previous `--checks` flag.
#[clap(long,
default_value = "None",
default_missing_value = "All",
default_value = "pre-and-post",
default_missing_value = "all",
num_args = 0..=1,
require_equals = true,
verbatim_doc_comment)]
@@ -134,10 +134,10 @@
//!
//! ```ignore
//!
//! #[cfg(feature = try-runtime)]
//! #[cfg(feature = "try-runtime")]
//! fn pre_upgrade() -> Result<Vec<u8>, &'static str> {}
//!
//! #[cfg(feature = try-runtime)]
//! #[cfg(feature = "try-runtime")]
//! fn post_upgrade(state: Vec<u8>) -> Result<(), &'static str> {}
//! ```
//!
@@ -152,9 +152,9 @@
//!
//! Similarly, each pallet can expose a function in `#[pallet::hooks]` section as follows:
//!
//! ```
//! #[cfg(feature = try-runtime)]
//! fn try_state(_) -> Result<(), &'static str> {}
//! ```ignore
//! #[cfg(feature = "try-runtime")]
//! fn try_state(_: BlockNumber) -> Result<(), &'static str> {}
//! ```
//!
//! which is called on numerous code paths in the try-runtime tool. These checks should ensure that