From ac99b1bb76a52efc7aedf850ff7e3b3939853553 Mon Sep 17 00:00:00 2001 From: Henrik Kurelid Date: Sun, 4 Oct 2026 14:04:26 +0200 Subject: [PATCH] =?UTF-8?q?docs(nr-alq):=20mockup=20=E2=80=94=20NES-only?= =?UTF-8?q?=20warning=20wording?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01LVRofEfeNLomkfCdoQ6yV6 --- docs/ui/nr-alq-trace-cpu-release-warning.html | 34 +++++++++++-------- 1 file changed, 20 insertions(+), 14 deletions(-) diff --git a/docs/ui/nr-alq-trace-cpu-release-warning.html b/docs/ui/nr-alq-trace-cpu-release-warning.html index abc854d35..01deb4404 100644 --- a/docs/ui/nr-alq-trace-cpu-release-warning.html +++ b/docs/ui/nr-alq-trace-cpu-release-warning.html @@ -1,23 +1,29 @@ CPU trace warning -

CPU trace in a release build — help line and warning

Shown once, at start-up, on the error stream, and only in a release build. It names whichever spelling you typed (--trace or --trace-cpu). In a debug build, or without the flag, nothing new appears.

+.hl{color:var(--hl)} .w{color:var(--warn)} .d{color:var(--dim)}

CPU trace in a release build — help line and NES-only warning

+

Same help line as A. The warning appears only when the game being run is an NES game. Super Nintendo, Game Boy and Game Boy Color runs, whose instruction lines do print in a release build, get no warning.

neser --help (same text in every build)

$ neser --help
 ...
 Trace and Debugging:
-  --trace             Enable CPU trace output (instructions only in debug builds)
-  --trace-cpu         Enable CPU trace output (instructions only in debug builds)
-  --debugger-alpha    Debugger window opacity: 0.1 (transparent) to 1.0 (opaque, default: 0.7)
-  ...
-

Release build, headless run

$ target/release/neser --headless --trace-cpu --output out.png game.nes
-warning: --trace-cpu: this release build prints CPU interrupts only; build without --release for instruction lines
-[CPU] NMI ...
+  --trace             Enable CPU trace output (NES instructions only in debug builds)
+  --trace-cpu         Enable CPU trace output (NES instructions only in debug builds)
+  ...

Release build, NES game, headless

$ target/release/neser --headless --trace-cpu --output out.png game.nes
+warning: --trace-cpu: this release build prints no NES instruction lines; build without --release for them
 [CPU] NMI ...
-

Release build, windowed, typed as --trace

$ target/release/neser --trace game.nes
-warning: --trace: this release build prints CPU interrupts only; build without --release for instruction lines
+
Release build, Super Nintendo game — no warning
$ target/release/neser --headless --trace-cpu=2 --output out.png game.sfc
+00:8000 SEI ...
+  [read] 00:8000 ...

+
Release build, windowed, no game on the command line — then an NES game opened from the menu
$ target/release/neser --trace
+(window opens; nothing printed yet)
+(game.nes chosen from the menu)
+warning: --trace: this release build prints no NES instruction lines; build without --release for them
 [CPU] NMI ...

-
Debug build — no warning
$ target/debug/neser --headless --trace-cpu --output out.png game.nes
+
Started without a game: the warning appears once, as the first NES game of the run starts, before any trace line.

+
Debug build, NES game — no warning
$ target/debug/neser --headless --trace-cpu --output out.png game.nes
 C000  78        SEI ...
 [CPU] NMI ...

\ No newline at end of file