[clangd] Release notes for b8c37153d5393aad96
authorSam McCall <sam.mccall@gmail.com>
Tue, 22 Dec 2020 21:58:39 +0000 (22:58 +0100)
committerSam McCall <sam.mccall@gmail.com>
Tue, 22 Dec 2020 21:58:45 +0000 (22:58 +0100)
clang-tools-extra/docs/ReleaseNotes.rst

index 450b80f..2960aad 100644 (file)
@@ -47,7 +47,17 @@ Major New Features
 Improvements to clangd
 ----------------------
 
-The improvements are...
+- clangd's memory usage is significantly reduced on most Linux systems.
+  In particular, memory usage should not increase dramatically over time.
+
+  The standard allocator on most systems is glibc's ptmalloc2, and it creates
+  disproportionately large heaps when handling clangd's allocation patterns.
+  By default, clangd will now periodically call ``malloc_trim`` to release free
+  pages on glibc systems.
+
+  Users of other allocators (such as ``jemalloc`` or ``tcmalloc``) on glibc
+  systems can disable this using ``--malloc_trim=0`` or the CMake flag
+  ``-DCLANGD_MALLOC_TRIM=0``.
 
 Improvements to clang-doc
 -------------------------