Skip to content

tmux: add notes to existing keybindings (#2540)#2742

Merged
berbiche merged 1 commit intonix-community:masterfrom
LogicalOverflow:master
Mar 19, 2022
Merged

tmux: add notes to existing keybindings (#2540)#2742
berbiche merged 1 commit intonix-community:masterfrom
LogicalOverflow:master

Conversation

@LogicalOverflow
Copy link
Copy Markdown
Contributor

Description

This PR adds notes to the keybindings created in the tmux config, making them show up when checking C-b ? or tmux list-keys -N, fixing #2540. I also adjusted the reference configs in the test cases to expect the notes.

Keys without notes are not displayed when checking C-b ? (since tmux 3.1), making them hard to discover for users.

The explanations are mostly taken from/based on the tmux man-page (which is licensed under Zero-Clause BSD).

I ran all tests which don't complain about the shellDryRun attribute missing (see #2722) and all tests that pass without the commit also pass with it (only herbstluftwm-simple-config fails, both with and without my commit).

Checklist

  • Change is backwards compatible.

  • Code formatted with ./format.

  • Code tested through nix-shell --pure tests -A run.all. (Mostly of done, see above)

  • Test cases updated/added. See example.

  • Commit messages are formatted like

    {component}: {description}
    
    {long description}
    

    See CONTRIBUTING for more information and recent commit messages for examples.

  • If this PR adds a new module

    • Added myself as module maintainer. See example.

    • Added myself and the module files to .github/CODEOWNERS.

Adds notes to the keybindings created in the tmux config making them
show up in C-b ? and tmux list-keys -N

Fixes nix-community#2540
Copy link
Copy Markdown
Contributor

@toonn toonn left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Copy Markdown
Member

@berbiche berbiche left a comment

Choose a reason for hiding this comment

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

Thanks!

@berbiche berbiche merged commit e96fc6d into nix-community:master Mar 19, 2022
jficz pushed a commit to jficz/home-manager that referenced this pull request Apr 7, 2022
…munity#2742)

Adds notes to the keybindings created in the tmux config making them
show up in C-b ? and tmux list-keys -N

Fixes nix-community#2540
@teto teto mentioned this pull request Aug 22, 2022
7 tasks
teto pushed a commit to teto/home-manager that referenced this pull request Aug 22, 2022
…munity#2742)

Adds notes to the keybindings created in the tmux config making them
show up in C-b ? and tmux list-keys -N

Fixes nix-community#2540
spacekookie pushed a commit to spacekookie/home-manager that referenced this pull request Feb 10, 2023
…munity#2742)

Adds notes to the keybindings created in the tmux config making them
show up in C-b ? and tmux list-keys -N

Fixes nix-community#2540
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants