Skip to content

Prevent shell-echo races in automation docs #709

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

Open
tony wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Prevent shell-echo races in automation docs #709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c3cedfb
Docs(fix[automation]): Prevent echo races
tony Jul 11, 2026
2aff5ac
Docs(fix[automation]): Stop check_for_errors matching the echo
tony Jul 11, 2026
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
13 changes: 13 additions & 0 deletions CHANGES
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,19 @@ _Notes on the upcoming release will go here._

### Documentation

#### The automation recipes no longer race the shell's echo (#709)

Every wait helper in {ref}`automation-patterns` returned the moment the command was
*sent*, not when it finished. {meth}`~libtmux.Pane.send_keys` types into the pane, so
the shell echoes it straight back, and the helpers matched their completion marker
against that echo. A copied `wait_for_output(pane, 'READY')` returned `True` in
milliseconds, before the command had printed anything, and its timeout branch was
unreachable. `check_for_errors` had the same fault in reverse: it reported a crash for
any healthy command whose own arguments happened to mention an error.

The recipes now synchronize through {meth}`~libtmux.Server.wait_for` channels where the
command is yours to change, and where a poll is genuinely needed they match complete
output lines that cannot also occur in the echoed input.
#### Cleaner `from_env` examples (#719)

The rendered examples for {meth}`Pane.from_env() <libtmux.Pane.from_env>` and
Expand Down
Loading
Loading