summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorFederico Ceratto <federico.ceratto@gmail.com>2021-01-01 17:36:20 +0000
committerGitHub <noreply@github.com>2021-01-01 18:36:20 +0100
commite67059a03a02b53919fafd0f99eb59baa9ad9a53 (patch)
tree566ca70fe6f9d3879a3adfc2c2256ad32d1f6c16
parent4a479f4a6eb2f9c5a3665d95fa86d993fdb66281 (diff)
downloadNim-e67059a03a02b53919fafd0f99eb59baa9ad9a53.tar.gz
Add short description on GC (#16535)
-rw-r--r--doc/gc.rst9
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/gc.rst b/doc/gc.rst
index 804481cd9..a19ad0671 100644
--- a/doc/gc.rst
+++ b/doc/gc.rst
@@ -14,10 +14,15 @@ Nim's Memory Management
 Introduction
 ============
 
-This document describes how the multi-paradigm memory management strategies work.
+A memory-management algorithm optimal for every use-case cannot exist.
+Nim provides multiple paradigms for needs ranging from large multi-threaded
+applications, to games, hard-realtime systems and small microcontrollers.
+
+This document describes how the management strategies work;
 How to tune the garbage collectors for your needs, like (soft) `realtime systems`:idx:,
-and how the memory management strategies that are not garbage collectors work.
+and how the memory management strategies other than garbage collectors work.
 
+.. note:: the default GC is incremental, thread-local and not "stop-the-world"
 
 Multi-paradigm Memory Management Strategies
 ===========================================