Skip to content

Commit 3283e45

Browse files
Documentation for --debug flag.
1 parent 1e708b8 commit 3283e45

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/init.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,13 @@ This command would create a `package.json` file for a package called
4646
`@test/js-hello-world`. For more information about scoping, you can refer to
4747
the npm documentation [here][npm-scope-documentation].
4848

49+
## Debug
50+
51+
The init command accepts an optional `--debug` argument. This will build the
52+
output package using cargo's
53+
[default non-release profile][cargo-profile-sections-documentation]. Building
54+
this way is faster but applies few optimizations to the output, and enables
55+
debug assertions and other runtime correctness checks.
56+
4957
[npm-scope-documentation]: https://docs.npmjs.com/misc/scope
58+
[cargo-profile-sections-documentation]: https://doc.rust-lang.org/cargo/reference/manifest.html#the-profile-sections

0 commit comments

Comments
 (0)