Fix invalid link in doc (#9351)

* fix invalid link

* Update client/executor/common/src/runtime_blob/globals_snapshot.rs

* more fix
This commit is contained in:
Guillaume Thiolliere
2021-07-16 09:24:26 +02:00
committed by GitHub
parent 76d147439a
commit 1e8035a273
13 changed files with 52 additions and 35 deletions
@@ -47,7 +47,9 @@ pub trait InstanceGlobals {
/// A set of exposed mutable globals.
///
/// This is set of globals required to create a [`GlobalsSnapshot`] and that are collected from
/// a runtime blob that was instrumented by [`InstrumentModule::expose_mutable_globals`].
/// a runtime blob that was instrumented by
/// [`RuntimeBlob::expose_mutable_globals`](super::RuntimeBlob::expose_mutable_globals`).
///
/// If the code wasn't instrumented then it would be empty and snapshot would do nothing.
pub struct ExposedMutableGlobalsSet(Vec<String>);
@@ -296,8 +296,8 @@ pub struct DeterministicStackLimit {
/// after translation into machine code. It is also not quite trivial.
///
/// Therefore, this number should be choosen conservatively. It must be so large so that it can
/// fit the [`logical_max`] logical values on the stack, according to the current instrumentation
/// algorithm.
/// fit the [`logical_max`](Self::logical_max) logical values on the stack, according to the current
/// instrumentation algorithm.
///
/// This value cannot be 0.
pub native_stack_max: u32,
@@ -315,8 +315,9 @@ pub struct Semantics {
/// This is not a problem for a standard substrate runtime execution because it's up to the
/// runtime itself to make sure that it doesn't involve any non-determinism.
///
/// Since this feature depends on instrumentation, it can be set only if [`CodeSupplyMode::Verbatim`]
/// is used.
/// Since this feature depends on instrumentation, it can be set only if runtime is
/// instantiated using the runtime blob, e.g. using [`create_runtime`].
// I.e. if [`CodeSupplyMode::Verbatim`] is used.
pub fast_instance_reuse: bool,
/// Specifiying `Some` will enable deterministic stack height. That is, all executor invocations
@@ -326,8 +327,9 @@ pub struct Semantics {
/// This is achieved by a combination of running an instrumentation pass on input code and
/// configuring wasmtime accordingly.
///
/// Since this feature depends on instrumentation, it can be set only if [`CodeSupplyMode::Verbatim`]
/// is used.
/// Since this feature depends on instrumentation, it can be set only if runtime is
/// instantiated using the runtime blob, e.g. using [`create_runtime`].
// I.e. if [`CodeSupplyMode::Verbatim`] is used.
pub deterministic_stack_limit: Option<DeterministicStackLimit>,
/// Controls whether wasmtime should compile floating point in a way that doesn't allow for
+2 -2
View File
@@ -127,9 +127,9 @@ pub struct Params<B: BlockT, H: ExHashT> {
/// Request response configuration for the state request protocol.
///
/// Can be constructed either via
/// [`crate::state_requests::generate_protocol_config`] allowing outgoing but not
/// [`crate::block_request_handler::generate_protocol_config`] allowing outgoing but not
/// incoming requests, or constructed via
/// [`crate::state_requests::handler::StateRequestHandler::new`] allowing
/// [`crate::state_request_handler::StateRequestHandler::new`] allowing
/// both outgoing and incoming requests.
pub state_request_protocol_config: RequestResponseConfig,
}
@@ -19,7 +19,8 @@
//! Helper for incoming light client requests.
//!
//! Handle (i.e. answer) incoming light client requests from a remote peer received via
//! [`crate::request_responses::RequestResponsesBehaviour`] with [`LightClientRequestHandler`].
//! [`crate::request_responses::RequestResponsesBehaviour`] with
//! [`LightClientRequestHandler`](handler::LightClientRequestHandler).
use codec::{self, Encode, Decode};
use crate::{
@@ -18,15 +18,16 @@
//! Helper for outgoing light client requests.
//!
//! Call [`LightClientRequestSender::send_request`] to send out light client requests. It will:
//! Call [`LightClientRequestSender::request`](sender::LightClientRequestSender::request)
//! to send out light client requests. It will:
//!
//! 1. Build the request.
//!
//! 2. Forward the request to [`crate::request_responses::RequestResponsesBehaviour`] via
//! [`OutEvent::SendRequest`].
//! [`OutEvent::SendRequest`](sender::OutEvent::SendRequest).
//!
//! 3. Wait for the response and forward the response via the [`futures::channel::oneshot::Sender`] provided earlier
//! with [`LightClientRequestSender::send_request`].
//! with [`LightClientRequestSender::request`](sender::LightClientRequestSender::request).
use codec::{self, Encode, Decode};
use crate::{