Skip to content

Commit 55ac83f

Browse files
committed
docs(control): add control-engine testing guidance
why: Communicate tmux >=3.2 requirement and how to run control-mode suite. what: - Note minimum tmux version for control mode - Add instructions for running pytest --engine=control and related make target
1 parent b57d0c9 commit 55ac83f

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

docs/topics/control_mode.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -169,9 +169,8 @@ print(server.list_sessions()) # legacy behavior
169169

170170
## Environment propagation requirements
171171

172-
- tmux **3.2 or newer** is required for ``-e KEY=VAL`` on ``new-session``,
173-
``new-window``, and ``split-window``. Older tmux versions ignore ``-e``; the
174-
library emits a warning and tests skip these cases.
172+
- libtmux requires tmux **3.2 or newer**; ``-e KEY=VAL`` on ``new-session``,
173+
``new-window``, and ``split-window`` is supported natively.
175174
- Environment tests and examples may wait briefly after ``send-keys`` so the
176175
shell prompt/output reaches the pane before capture.
177176

@@ -189,3 +188,9 @@ The pytest fixture ``control_sandbox`` provides an isolated control-mode tmux
189188
server with a unique socket, HOME/TMUX_TMPDIR isolation, and automatic cleanup.
190189
It is used by the regression suite and can be reused in custom tests when you
191190
need a hermetic control-mode client.
191+
192+
## Testing control mode
193+
194+
- Run `uv run pytest --engine=control` to execute the suite against the
195+
control-mode engine. CI runs both subprocess and control engines across
196+
supported tmux versions.

0 commit comments

Comments
 (0)