Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update statements mappings docs #1375

Merged
merged 2 commits into from
Jun 19, 2024
Merged

Update statements mappings docs #1375

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d64b5ec
Update statements mappings docs
piotmag769 Jun 19, 2024
8178c40
fix formatting
piotmag769 Jun 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions scarb/src/core/manifest/compiler_config.rs
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
Loading