[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/better-jumper e5768d3812 22/48: Readme updates
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/better-jumper e5768d3812 22/48: Readme updates |
Date: |
Sun, 9 Jan 2022 22:58:10 -0500 (EST) |
branch: elpa/better-jumper
commit e5768d38125f167812ea6bfdcded1656b4d77c42
Author: Bryan Gilbert <gilbertw1@gmail.com>
Commit: Bryan Gilbert <gilbertw1@gmail.com>
Readme updates
---
Readme.md | 21 +++++++++++++++++++++
1 file changed, 21 insertions(+)
diff --git a/Readme.md b/Readme.md
index 8fa5b29474..634ae6e35d 100644
--- a/Readme.md
+++ b/Readme.md
@@ -17,6 +17,8 @@ functions can be used to navigate through the jump history.
If you are an `evil` user then `better-jumper` can piggy back off of the built
in jumplist implementation to track when jumps occur. The setting
`better-jumper-use-evil-jump-advice` dictates this behavior and defaults to
`t`.
+Note that `better-jumper` does not interact with or alter evil's jump list in
+any way.
## Summary of interactive commands
@@ -48,6 +50,13 @@ list is maintained for each individual buffer. Conversly, if
the value is
`'window` then the jump list is maintained per window and will operate across
buffers in that window.
+While in the `'window` context, jump lists are stored as persistent window
+parameters and can be saved and restored along with the window configuration
+using something like `desktop` or `persp-mode`. This is the default context.
+
+While in the `'buffer` context, jump lists are maintained using buffer-local
+variables and can optionally by saved using `savehist`.
+
#### New Window Behavior (`better-jumper-new-window-behavior`)
This setting specifies the behavior that will take place when a new window is
@@ -110,3 +119,15 @@ A few advantages of `better-jumper` are:
* Configurable new window behavior. `evil-jumper` ALWAYS copies the jump list
from the previously selected window to any newly created window.
+
+# Caveats
+
+* Jump locations are stored as `marker`s so they will maintain a more accurate
+ location in the buffer. However, due to the fact thay markers can't be
+ serialized they are down converted to simple buffer positions when saved
+ either via window configuration or savehist.
+
+* Currently `savehist` support is only limited to the `'buffer` context. When
+ running in the `'window` context, the jump list is stored as a persistent
+ window parameter and is intended to be saved using alongside the window
+ configuration using somethinig like `desktop` or `persp-mode`.
- [nongnu] elpa/better-jumper 06a98185e8 04/48: propertly maintain / cleanup buffer + window jumps, (continued)
- [nongnu] elpa/better-jumper 06a98185e8 04/48: propertly maintain / cleanup buffer + window jumps, ELPA Syncer, 2022/01/09
- [nongnu] elpa/better-jumper 3624896c72 05/48: add documentation, ELPA Syncer, 2022/01/09
- [nongnu] elpa/better-jumper d6ecaa1f96 07/48: minor refactors + cleanup, ELPA Syncer, 2022/01/09
- [nongnu] elpa/better-jumper 719e412f43 03/48: Add support restricting jump list to contexts, ELPA Syncer, 2022/01/09
- [nongnu] elpa/better-jumper c307a253d9 09/48: Fixup copy struct function, ELPA Syncer, 2022/01/09
- [nongnu] elpa/better-jumper f9f0180894 13/48: update documentation, ELPA Syncer, 2022/01/09
- [nongnu] elpa/better-jumper 8d2b5f4c3a 11/48: Re-implement buffer context support using locals, ELPA Syncer, 2022/01/09
- [nongnu] elpa/better-jumper 50bf0f7ee7 15/48: add finder-known-keyword to Keywords, ELPA Syncer, 2022/01/09
- [nongnu] elpa/better-jumper 055051c391 16/48: cleanup byte compiler warnings, ELPA Syncer, 2022/01/09
- [nongnu] elpa/better-jumper dfb80f0eb4 21/48: Add savehist support for buffer context, ELPA Syncer, 2022/01/09
- [nongnu] elpa/better-jumper e5768d3812 22/48: Readme updates,
ELPA Syncer <=
- [nongnu] elpa/better-jumper 3d27c44b6a 23/48: Fix duplicate jump protection, ELPA Syncer, 2022/01/09
- [nongnu] elpa/better-jumper 2b85b3a83e 26/48: Correct typo in reference to better-jumper--load-savehist, ELPA Syncer, 2022/01/09
- [nongnu] elpa/better-jumper f3d6c048cc 27/48: Fix byte-compiler warning about free variable, ELPA Syncer, 2022/01/09
- [nongnu] elpa/better-jumper 6d240032ca 29/48: Merge pull request #2 from hlissner/patch-2, ELPA Syncer, 2022/01/09
- [nongnu] elpa/better-jumper 7ae4011103 31/48: Don't add redundant evil jumps. Fixes #5, ELPA Syncer, 2022/01/09
- [nongnu] elpa/better-jumper b2cc34493c 39/48: Require cl-macs to fix byte compiling, ELPA Syncer, 2022/01/09
- [nongnu] elpa/better-jumper 879ce3939f 14/48: update commentary, ELPA Syncer, 2022/01/09
- [nongnu] elpa/better-jumper 7f328a886b 45/48: Utilize evil jump var to avoid redundant jumps, ELPA Syncer, 2022/01/09
- [nongnu] elpa/better-jumper 9b214d71e6 37/48: Merge pull request #8 from sgleizes/bugfix/copy-jump-list-on-focused-new-window, ELPA Syncer, 2022/01/09
- [nongnu] elpa/better-jumper 17821e7f55 47/48: Bump version to 1.0.1, ELPA Syncer, 2022/01/09