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

forc: Improve the print_*_asm CLI option docs #2095

Merged
merged 2 commits into from
Jun 23, 2022
Merged

forc: Improve the print_*_asm CLI option docs #2095

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
91e45ce
forc: Improve the `print_*_asm` CLI option docs
mitchmindtree Jun 23, 2022
6c0d000
Merge branch 'master' into mitchmindtree/forc-improve-print-asm-cli-doc
mohammadfawaz Jun 23, 2022
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
11 changes: 8 additions & 3 deletions forc/src/cli/commands/build.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,18 @@ pub struct Command {
/// Path to the project, if not specified, current working directory will be used.
#[clap(short, long)]
pub path: Option<String>,
/// Whether to compile to bytecode (false) or to print out the generated ASM (true).
/// Print the finalized ASM.
///
/// This is the state of the ASM with registers allocated and optimisations applied.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// This is the state of the ASM with registers allocated and optimisations applied.
/// This is the state of the ASM with registers allocated and optimizations applied.

American English perhaps? Seems good otherwise

#[clap(long)]
pub print_finalized_asm: bool,
/// Whether to compile to bytecode (false) or to print out the generated ASM (true).
/// Print the generated ASM.
///
/// This is the state of the ASM prior to performing register allocation and other ASM
/// optimisations.
#[clap(long)]
pub print_intermediate_asm: bool,
/// Whether to compile to bytecode (false) or to print out the generated IR (true).
/// Print the generated Sway IR (Intermediate Representation).
#[clap(long)]
pub print_ir: bool,
/// If set, outputs a binary file representing the script bytes.
Expand Down
11 changes: 8 additions & 3 deletions forc/src/cli/commands/deploy.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,18 @@ pub struct Command {
/// Path to the project, if not specified, current working directory will be used.
#[clap(short, long)]
pub path: Option<String>,
/// Whether to compile to bytecode (false) or to print out the generated ASM (true).
/// Print the finalized ASM.
///
/// This is the state of the ASM with registers allocated and optimisations applied.
#[clap(long)]
pub print_finalized_asm: bool,
/// Whether to compile to bytecode (false) or to print out the generated ASM (true).
/// Print the generated ASM.
///
/// This is the state of the ASM prior to performing register allocation and other ASM
/// optimisations.
#[clap(long)]
pub print_intermediate_asm: bool,
/// Whether to compile to bytecode (false) or to print out the IR (true).
/// Print the generated Sway IR (Intermediate Representation).
#[clap(long)]
pub print_ir: bool,
/// If set, outputs a binary file representing the script bytes.
Expand Down
11 changes: 8 additions & 3 deletions forc/src/cli/commands/run.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,20 @@ pub struct Command {
#[clap(short, long)]
pub kill_node: bool,

/// Whether to compile to bytecode (false) or to print out the generated ASM (true).
/// Print the finalized ASM.
///
/// This is the state of the ASM with registers allocated and optimisations applied.
#[clap(long)]
pub print_finalized_asm: bool,

/// Whether to compile to bytecode (false) or to print out the generated ASM (true).
/// Print the generated ASM.
///
/// This is the state of the ASM prior to performing register allocation and other ASM
/// optimisations.
#[clap(long)]
pub print_intermediate_asm: bool,

/// Whether to compile to bytecode (false) or to print out the IR (true).
/// Print the generated Sway IR (Intermediate Representation).
#[clap(long)]
pub print_ir: bool,

Expand Down