Skip to content

Commit

Permalink
Update statements mappings docs (#1375)
Browse files Browse the repository at this point in the history
Forgot to do it when the semantic changed
  • Loading branch information
piotmag769 authored Jun 19, 2024
1 parent 0750a15 commit 98c32c7
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 6 deletions.
5 changes: 3 additions & 2 deletions scarb/src/core/manifest/compiler_config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,9 @@ pub struct ManifestCompilerConfig {
/// Enable auto gas withdrawal and gas usage check.
pub enable_gas: bool,
/// Add a mapping between sierra statement indexes and fully qualified paths of cairo functions
/// to debug info. A statement index maps to a function which caused the statement to be
/// generated. Used by [cairo-profiler](https://github.com/software-mansion/cairo-profiler).
/// to debug info. A statement index maps to a vector consisting of a function which caused the
/// statement to be generated and all functions that were inlined or generated along the way.
/// Used by [cairo-profiler](https://github.com/software-mansion/cairo-profiler).
/// This feature is unstable and is subject to change.
pub unstable_add_statements_functions_debug_info: bool,
}
Expand Down
5 changes: 3 additions & 2 deletions scarb/src/core/manifest/toml_manifest.rs
Original file line number Diff line number Diff line change
Expand Up @@ -315,8 +315,9 @@ pub struct TomlCairo {
/// Enable auto gas withdrawal and gas usage check.
pub enable_gas: Option<bool>,
/// Add a mapping between sierra statement indexes and fully qualified paths of cairo functions
/// to debug info. A statement index maps to a function which caused the statement to be
/// generated. Used by [cairo-profiler](https://github.com/software-mansion/cairo-profiler).
/// to debug info. A statement index maps to a vector consisting of a function which caused the
/// statement to be generated and all functions that were inlined or generated along the way.
/// Used by [cairo-profiler](https://github.com/software-mansion/cairo-profiler).
/// This feature is unstable and is subject to change.
pub unstable_add_statements_functions_debug_info: Option<bool>,
}
Expand Down
5 changes: 3 additions & 2 deletions website/docs/reference/manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -285,8 +285,9 @@ This flag cannot be disabled while compiling the `starknet-contract` target.
> It may slow down the compilation - it is advised not to use it for other purposes than mentioned in
> [cairo-profiler](https://github.com/software-mansion/cairo-profiler) documentation.
If enabled, during the project compilation Scarb will add mapping between Sierra statement indexes and fully qualified
paths of Cairo functions to debug info. A statement index maps to a function which caused the statement to be generated.
If enabled, during the project compilation Scarb will a add mapping between Sierra statement indexes and vectors of fully
qualified paths of Cairo functions to debug info. A statement index maps to a vector consisting of a function which
caused the statement to be generated and all functions that were inlined or generated along the way.
By default, this flag is disabled.

```toml
Expand Down

0 comments on commit 98c32c7

Please sign in to comment.