Skip to content

Commit dabed1f

Browse files
committed
Update docs to reflect autogenerated README
1 parent 1ccf80e commit dabed1f

2 files changed

Lines changed: 9 additions & 3 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -135,8 +135,8 @@ after the migration. [`OnRuntimeUpgrade::pre_upgrade`] returns a [`Vec<u8>`] tha
135135
arbitrary encoded data (usually some pre-upgrade state) which will be passed to
136136
[`OnRuntimeUpgrade::pre_upgrade`] after upgrading and used for post checking.
137137

138-
**Note on Multi-Block Migrations (MBM):** If the runtime uses MBMs, the standard
139-
`pre_upgrade` and `post_upgrade` checks might be skipped by the executive. To
138+
**Note on Multi-Block Migrations (MBM):** If the runtime uses MBMs, the standard
139+
`pre_upgrade` and `post_upgrade` checks might be skipped by the executive. To
140140
force these hooks to run synchronously for testing, use the `--disable-mbm-checks` flag.
141141

142142
### [`VersionedMigration`]
@@ -285,7 +285,7 @@ try-runtime \
285285
[`Action::OffchainWorker`]: try_runtime_core::commands::Action::OffchainWorker
286286
[`Action::CreateSnapshot`]: try_runtime_core::commands::Action::CreateSnapshot
287287
[`Action::FastForward`]: try_runtime_core::commands::Action::FastForward
288-
[`SharedParams`]: try_runtime_core::shared_parameters::SharedParams
288+
[`SharedParams`]: try_runtime_core::common::shared_parameters::SharedParams
289289
[`SharedParams::runtime`]: try_runtime_core::common::shared_parameters::SharedParams::runtime
290290
[`SharedParams::overwrite_state_version`]: try_runtime_core::common::shared_parameters::SharedParams::overwrite_state_version
291291

cli/main.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,10 @@
151151
//! arbitrary encoded data (usually some pre-upgrade state) which will be passed to
152152
//! [`OnRuntimeUpgrade::pre_upgrade`] after upgrading and used for post checking.
153153
//!
154+
//! **Note on Multi-Block Migrations (MBM):** If the runtime uses MBMs, the standard
155+
//! `pre_upgrade` and `post_upgrade` checks might be skipped by the executive. To
156+
//! force these hooks to run synchronously for testing, use the `--disable-mbm-checks` flag.
157+
//!
154158
//! ### [`VersionedMigration`]
155159
//!
156160
//! It is strongly suggested to use [`VersionedMigration`] when writing custom migrations for
@@ -198,6 +202,8 @@
198202
//! try-runtime \
199203
//! --runtime /path-to-substrate/target/release/wbuild/my-runtime.wasm \
200204
//! on-runtime-upgrade \
205+
//! # Passing this flag will skip multi-block-migration checks and only run pre_upgrade/post_upgrade checks.
206+
//! --disable-mbm-checks \
201207
//! live --uri ws://localhost:9999
202208
//! ```
203209
//!

0 commit comments

Comments
 (0)