Skip to content

docs(dash): narrow the test-clock warning's entry points #657

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

Merged
rominf merged 1 commit into from
Oct 14, 2026
Merged

docs(dash): narrow the test-clock warning's entry points #657

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 9 additions & 5 deletions apps/rocm/src/dash.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,11 +128,15 @@ const fn gpu_reachable_for_preflight(is_wsl_host: bool, has_usable_gpu: bool) ->
/// logical clock rather than restoring wall time. The warning goes to `tracing`, not
/// stdout/stderr. It is reached through [`runner_options`], which runtime code
/// calls only from [`maybe_spawn_embedded_daemon`]; `run_async` calls that only
/// when [`should_spawn_daemon`] holds, i.e. for a live `rocm dash` and for
/// `rocm chat` (including the launcher's routes into them), not for a focused
/// overlay or `rocm dash --replay`/`--demo`. On those paths the process is about
/// to hand the terminal to the TUI, and the client log is file-only (see
/// `logging.rs`), so a stray stdout/stderr write would corrupt the display.
/// when [`should_spawn_daemon`] holds, i.e. for a live `rocm dash` and for an
/// interactive `rocm chat` (including the launcher's routes into them; a
/// non-interactive `rocm chat` renders text and never enters `run_async`), not
/// for a focused overlay or `rocm dash --replay`/`--demo`. All of this is
/// unix-only: on Windows `maybe_spawn_embedded_daemon` never calls

@juhovainio juhovainio Oct 13, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Nitpick, not blocking: runner_options and maybe_spawn_embedded_daemon are already linked a few lines up in this same comment ([`runner_options`], [`maybe_spawn_embedded_daemon`]); these re-mentions use plain code spans instead. Worth the same [...] link style for consistency, but not worth holding this up for.

@rominf rominf Oct 14, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Will switch those re-mentions to the same intra-doc link style in a small follow-up, so this approved doc fix can land as is.

/// `runner_options`, so no entry point reaches the warning. On the paths that
/// do reach it, the process is about to hand the terminal to the TUI, and the
/// client log is file-only (see `logging.rs`), so a stray stdout/stderr write
/// would corrupt the display.
fn dash_test_clock_offset_path(paths: &AppPaths) -> Option<PathBuf> {
let path = paths.dash_test_clock_file();
if !path.is_file() {
Expand Down
Loading