branch: externals/gcmh
commit e7af13d7743457ed430a9858fa35a3720c55dec6
Author: Andrea Corallo <[email protected]>
Commit: Andrea Corallo <[email protected]>
better readme layout
---
README.org | 13 +++++++++----
1 file changed, 9 insertions(+), 4 deletions(-)
diff --git a/README.org b/README.org
index 298e154..dd53364 100644
--- a/README.org
+++ b/README.org
@@ -4,16 +4,21 @@
Enforce a sneaky Garbage Collection strategy to minimize GC interference with
the activity.
+
During normal use a high GC threshold is set.
+
When idling GC is immediately triggered and a low threshold is set.
+
A more detailed explanation of the rationale behind this can be found at:
[[http://akrl.sdf.org/]]
- WARNING: in case Emacs is used in system already under severe memory pressure
- be sure to understand how GCMH works and trim ~gcmh-high-cons-threshold~
- accordingly. Default value may be to big and/or GCMH may not fit your use
- case.
+*** WARNING
+
+ In case Emacs is used in a system already under severe memory pressure
+ be sure to understand how GCMH works and trim ~gcmh-high-cons-threshold~
+ accordingly. Default value may be to big and/or GCMH may not fit your use
+ case.
** Usage
