docs(tunnel): refresh stale TODO markers on usage-mode docstring (VA-1, VA-3, VA-4) #17

Merged

David merged 1 commit from docs/tunnel-mode-stale-comments into main

2026-05-17 14:31:15 +02:00

David commented

2026-05-17 05:05:11 +02:00

Owner

Summary

The crate-level docstring on crates/meshagent/src/host/tunnel.rs still flagged the Desktop / Files / FileTransfer usage modes as TODOs even though the real handlers (run_desktop, run_files) have been wired. ROADMAP picked up the stale markers and filed them as VA-1, VA-3, VA-4.

Per the actual code at lines 100-102 the dispatcher routes:

mode 1 -> run_terminal
mode 2 -> run_desktop (uses meshagent-kvm::stream::StreamState for tile-diff streaming + X11 XTEST for input)
mode 4 OR mode 5 -> run_files (ls, mkdir, mkfile, rm, rename, download start+chunks, upload chunks+done, findfile, copy, move)

No behavior change. Just refreshes the docstring so the next ROADMAP scan does not refile them.

Test plan

cargo check -p meshagent clean.
Reviewer: spot-check by opening a KVM session + a file browser in the SPA against a live agent.

Closes VA-1, VA-3, VA-4.

## Summary The crate-level docstring on `crates/meshagent/src/host/tunnel.rs` still flagged the Desktop / Files / FileTransfer usage modes as TODOs even though the real handlers (`run_desktop`, `run_files`) have been wired. ROADMAP picked up the stale markers and filed them as VA-1, VA-3, VA-4. Per the actual code at lines 100-102 the dispatcher routes: - mode 1 -> `run_terminal` - mode 2 -> `run_desktop` (uses `meshagent-kvm::stream::StreamState` for tile-diff streaming + X11 XTEST for input) - mode 4 OR mode 5 -> `run_files` (ls, mkdir, mkfile, rm, rename, download start+chunks, upload chunks+done, findfile, copy, move) No behavior change. Just refreshes the docstring so the next ROADMAP scan does not refile them. ## Test plan - [x] `cargo check -p meshagent` clean. - [ ] Reviewer: spot-check by opening a KVM session + a file browser in the SPA against a live agent. Closes VA-1, VA-3, VA-4.

David added 1 commit

2026-05-17 05:05:11 +02:00

docs(tunnel): refresh stale (TODO) markers on usage-mode docstring (VA-1, VA-3, VA-4)

Check / clippy + fmt + tests (pull_request) Failing after 1m39s

Details

3b9d90d46b

The crate-level docstring still flagged USAGE_DESKTOP, USAGE_FILES, and USAGE_FILE_TRANSFER as TODOs even though the real handlers (`run_desktop`, `run_files`) have been wired for some time. ROADMAP picked the (TODO) markers up and filed them as VA-1, VA-3, VA-4.

No behavior change. The docstring now cites the actual handler functions and explains that USAGE_FILE_TRANSFER (mode 5) reuses the `run_files` loop instead of a parallel "whole-file optimised" framing (the existing chunked download/upload covers the same UX; revisit when profiling actually surfaces per-byte overhead).

#VA-1 State Done
#VA-3 State Done
#VA-4 State Done