[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/undo-fu-session bf620f0a7c 1/2: readme: move exclusion opt
|
From: |
ELPA Syncer |
|
Subject: |
[nongnu] elpa/undo-fu-session bf620f0a7c 1/2: readme: move exclusion options into their own section |
|
Date: |
Wed, 31 May 2023 13:03:16 -0400 (EDT) |
branch: elpa/undo-fu-session
commit bf620f0a7c726c5d68fe9bd117951812e6948a65
Author: Campbell Barton <ideasman42@gmail.com>
Commit: Campbell Barton <ideasman42@gmail.com>
readme: move exclusion options into their own section
---
readme.rst | 20 ++++++++++++++++----
1 file changed, 16 insertions(+), 4 deletions(-)
diff --git a/readme.rst b/readme.rst
index e4189168c4..745315bed7 100644
--- a/readme.rst
+++ b/readme.rst
@@ -74,6 +74,22 @@ Customization
After changing, run ``undo-fu-session-compression-update`` to convert
existing files to the newly selected format.
+``undo-fu-session-file-limit`` (``nil``)
+ Number of files to store, nil to disable limiting entirely.
+
+ Enforcing removes the oldest files.
+
+
+Customization (Exclusions)
+--------------------------
+
+There are various methods of excluding undo-session storage,
+this may be done to prevent storing sensitive information
+or to prevent unnecessary storage of undo-session for temporary files (such as
commit messages).
+
+These exclusion options allow ``undo-fu-session-global-mode`` to be enabled.
+With exceptions added for cases where undo-session should not be stored.
+
``undo-fu-session-incompatible-files`` (``'()``)
List of regexps or functions for matching file names to ignore
saving/recovering undo session.
``undo-fu-session-incompatible-major-modes`` (``nil``)
@@ -85,10 +101,6 @@ Customization
``temporary-file-directory`` & ``undo-fu-session-temp-directories``.
``undo-fu-session-temp-directories`` (``'("/tmp" "/dev/shm")``)
Directories to consider temporary when
``undo-fu-session-ignore-temp-files`` is enabled.
-``undo-fu-session-file-limit`` (``nil``)
- Number of files to store, nil to disable limiting entirely.
-
- Enforcing removes the oldest files.
Details