Skip to content

Commit 632034e

Browse files
committed
docs(CHANGES): Add release notes for options and hooks features
why: Document new OptionsMixin and HooksMixin features for 0.49.x release. what: - Add breaking changes for renamed Window option methods - Document OptionsMixin with set_option, show_option, show_options, unset_option - Document HooksMixin with set_hook, show_hook, unset_hook, set_hooks - Document new Window.set_option() arguments
1 parent 4c1d248 commit 632034e

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

CHANGES

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,58 @@ deprecation announced in v0.48.0.
4444
- Removed version guards throughout the codebase
4545
- For users on older tmux, use libtmux v0.48.x
4646

47+
### Breaking changes
48+
49+
#### Renamed commands
50+
51+
- Rename `Window.set_window_option()` to {meth}`Window.set_option()` (#516)
52+
53+
Deprecate `Window.set_window_option()`
54+
55+
- Rename `Window.show_window_option()` to {meth}`Window.show_option()` (#516)
56+
57+
Deprecate `Window.show_window_option()`
58+
59+
- Rename `Window.show_window_options()` to {meth}`Window.show_options()` (#516)
60+
61+
Deprecate `Window.show_window_options()`
62+
63+
### Improved options
64+
65+
- Expand option support to server, session, window, and pane
66+
- Enhance and streamline option support via {class}`options.OptionsMixin`.
67+
68+
- `set_option`
69+
- `show_option`
70+
- `show_options`
71+
- `unset_option`
72+
73+
- {meth}`Window.set_option()` (#516)
74+
75+
Add arguments:
76+
77+
- `format` -> `-F`
78+
- `unset` -> `-u`
79+
- `global` -> `-g`
80+
- `unset_panes` -> `-U`: Also unset other panes in windows
81+
- `prevent_overwrite`: `-o`
82+
- `suppress_warnings`: `-q`
83+
- `append`: `-a`
84+
85+
#### Hooks
86+
87+
Add {class}`hooks.HooksMixin` for managing tmux hooks programmatically:
88+
89+
- {meth}`~hooks.HooksMixin.set_hook` - Set a hook with optional index
90+
- {meth}`~hooks.HooksMixin.show_hook` - Show current value of a hook
91+
- {meth}`~hooks.HooksMixin.unset_hook` - Remove a hook
92+
93+
Bulk operations API for managing indexed hooks:
94+
95+
- {meth}`~hooks.HooksMixin.set_hooks` - Set multiple indexed hooks at once
96+
97+
HooksMixin is available on {class}`Server`, {class}`Session`, {class}`Window`, and {class}`Pane`.
98+
4799
## libtmux 0.48.0 (2025-11-28)
48100

49101
### Breaking Changes

0 commit comments

Comments
 (0)