From c56cd3dd65980c633bee491194c56fb0b868f660 Mon Sep 17 00:00:00 2001 From: Jose <34888496+Jerry-Master@users.noreply.github.com> Date: Sun, 11 Feb 2024 21:52:49 +0100 Subject: [PATCH] docs: clarify --pretty option to expand (#3810) * Update debugging.md Added clarification. --pretty no longer works, and it breaks even on nightly at least on cargo 1.78.0-nightly (cdf84b69d 2024-02-02) and rustc 1.78.0-nightly (256b6fb19 2024-02-06). * Update guide/src/debugging.md Co-authored-by: David Hewitt --------- Co-authored-by: David Hewitt --- guide/src/debugging.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guide/src/debugging.md b/guide/src/debugging.md index e861f454..00c22631 100644 --- a/guide/src/debugging.md +++ b/guide/src/debugging.md @@ -16,7 +16,7 @@ You can also debug classic `!`-macros by adding `-Z trace-macros`: cargo rustc --profile=check -- -Z unstable-options --pretty=expanded -Z trace-macros > expanded.rs; rustfmt expanded.rs ``` -See [cargo expand](https://github.com/dtolnay/cargo-expand) for a more elaborate version of those commands. +Note that those commands require using the nightly build of rust and may occasionally have bugs. See [cargo expand](https://github.com/dtolnay/cargo-expand) for a more elaborate and stable version of those commands. ## Running with Valgrind