[nongnu] elpa/undo-fu d7ccafbd13 03/10: readme: add hint about undo limits

[ELPA Syncer]

branch: elpa/undo-fu
commit d7ccafbd1392dc5a2359f4b7996c7c48dfee427f
Author: Campbell Barton <ideasman42@gmail.com>
Commit: Campbell Barton <ideasman42@gmail.com>

    readme: add hint about undo limits
---
 readme.rst | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/readme.rst b/readme.rst
index e62df704db..137722cdf7 100644
--- a/readme.rst
+++ b/readme.rst
@@ -128,6 +128,30 @@ Evil mode can be configured to use ``undo-fu`` by default.
    (use-package undo-fu)
 
 
+Hints
+-----
+
+
+Undo Limits
+^^^^^^^^^^^
+
+The default undo limits for emacs are quite low _(0.15mb at time of writing)_
+``undo-tree`` for example increases these limits.
+
+On modern systems you may wish to use much higher limits.
+
+This example sets the limit to 64mb,
+1.5x (96mb) for the strong limit and
+10x (960mb) for the outer limit.
+_Emacs uses 100x for the outer limit but this may be too high when using 
increased limits._
+
+.. code-block:: elisp
+
+   (setq undo-limit 6710886400) ;; 64mb.
+   (setq undo-strong-limit 100663296) ;; 96mb.
+   (setq undo-outer-limit 1006632960) ;; 960mb.
+
+
 Other Packages
 ==============