tmux-plugins/tmux-resurrect
1
0
Fork 0
mirror of https://github.com/tmux-plugins/tmux-resurrect.git synced 2024-11-22 04:18:48 +00:00
Code Issues Projects Releases Wiki Activity

Deprecate restoring shell history

Browse Source 
"restoring shell history" feature is very invasive and dirty. I propose
removing it in the future without the replacement.

I worry it spoils the first experience of using this plugin for users
that accidentally turn it on and don't know how to turn it off, see
https://github.com/tmux-plugins/tmux-resurrect/issues/288

Also, it hurts me to reject PRs that improve the feature.

Thoughts?
This commit is contained in:
Bruno Sutic 2019-08-27 13:26:29 +02:00
parent e3f05dd34f
commit d7825683d1
No known key found for this signature in database
GPG Key ID: CAFA7B1B2914ED81
5 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -24,6 +24,7 @@
- delete resurrect files older than 30 days, but keep at least 5 files - delete resurrect files older than 30 days, but keep at least 5 files
- add save and restore hooks - add save and restore hooks
- always use `-ao` flags for `ps` command to detect commands - always use `-ao` flags for `ps` command to detect commands
- Deprecate restoring shell history feature.
### v2.4.0, 2015-02-23 ### v2.4.0, 2015-02-23
- add "tmux-test" - add "tmux-test"

1
README.md
View File

@ -49,7 +49,6 @@ Optional:
- [restoring vim and neovim sessions](docs/restoring_vim_and_neovim_sessions.md) - [restoring vim and neovim sessions](docs/restoring_vim_and_neovim_sessions.md)
- [restoring pane contents](docs/restoring_pane_contents.md) - [restoring pane contents](docs/restoring_pane_contents.md)
- [restoring shell history](docs/restoring_shell_history.md) (experimental)
Requirements / dependencies: `tmux 1.9` or higher, `bash`. Requirements / dependencies: `tmux 1.9` or higher, `bash`.

2
docs/hooks.md
View File

@ -20,7 +20,7 @@ Currently the following hooks are supported:
Called before any tmux state is altered. Called before any tmux state is altered.
- `@resurrect-hook-pre-restore-history` - `@resurrect-hook-pre-restore-history` - deprecated
Called after panes and layout have been restores, but before bash history is Called after panes and layout have been restores, but before bash history is
restored (if it is enabled) -- the hook is always called even if history restored (if it is enabled) -- the hook is always called even if history

6
docs/restoring_shell_history.md
View File

@ -1,4 +1,8 @@
# Restoring shell history (experimental) # Restoring shell history (deprecated, do not use)
This feature is deprecated because it's very invasive. It will be removed in
the future with no replacement. To see problems it causes check
[this issue](https://github.com/tmux-plugins/tmux-resurrect/issues/288).
**Supported shells**: `bash` and `zsh`. **Supported shells**: `bash` and `zsh`.

2
scripts/variables.sh
View File

@ -38,7 +38,7 @@ pane_contents_area_option="@resurrect-pane-contents-area"
default_pane_contents_area="full" default_pane_contents_area="full"
bash_history_option="@resurrect-save-bash-history" # deprecated bash_history_option="@resurrect-save-bash-history" # deprecated
shell_history_option="@resurrect-save-shell-history" shell_history_option="@resurrect-save-shell-history" # deprecated
# set to 'on' to ensure panes are never ever overwritten # set to 'on' to ensure panes are never ever overwritten
overwrite_option="@resurrect-never-overwrite" overwrite_option="@resurrect-never-overwrite"