Skip to content

Commit

Permalink
Merge pull request #66 from xxuejie/update-debug-macro-comments
Browse files Browse the repository at this point in the history
doc: Update debug macro doc with latest usage in release build
  • Loading branch information
xxuejie authored Jul 20, 2023
2 parents 0713d17 + 3e1729d commit 11da8e3
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions src/debug.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,15 @@
/// Output a debug message.
///
/// This macro only compiled under debug build and does nothing in release build. To debug the release build,
/// append the `--cfg debug_assertions` arguments to `cargo build`. For users of Capsule, the debug macro can
/// be enabled in the release build by running `capsule build --release --debug-output`.
/// include `--cfg debug_assertions` in the environment variable `RUSTFLAGS` before calling `cargo build`.
/// For example:
///
/// ```
/// RUSTFLAGS="--cfg debug_assertions" cargo build --release --target=riscv64imac-unknown-none-elf
/// ```
///
/// For users of Capsule, the debug macro can be enabled in the release build by running
/// `capsule build --release --debug-output`.
///
/// Notice: to see the debug output, you must turn on `ckb_script` debugging log in the CKB node configuration
/// like this:
Expand Down

0 comments on commit 11da8e3

Please sign in to comment.