From 6c8d43bae5a967fc2ffe9fab3f90344b23ce580b Mon Sep 17 00:00:00 2001 From: Kaz Kylheku Date: Mon, 26 Apr 2021 18:33:46 -0700 Subject: doc: document --free-all * txr.1: the --free-all command line option appeared in TXR 144 in 2016, but was never documented. --- txr.1 | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'txr.1') diff --git a/txr.1 b/txr.1 index 88663164..b9e54676 100644 --- a/txr.1 +++ b/txr.1 @@ -965,6 +965,15 @@ example, objects which have been reclaimed by the garbage collector are marked as inaccessible, and marked as uninitialized when they are allocated again. +.coIP --free-all +This option specifies that all memory allocated by \*(TX should be freed upon +normal termination. This behavior is useful for debugging memory leaks. +An accurate leak detection tool, such as the one built into Valgrind, +should report zero leaked or still reachable memory if +.code --free-all +has been used and \*(TX has terminated normally. +that indicates either a leak in \*(TX, a leak or global object retention +in a platform library, or else a a leak introduced due to misuse of FFI. .coIP --dv-regex If this option is used, then regular expressions are all treated using the derivative-based back-end. The NFA-based regex implementation is disabled. -- cgit v1.2.3