From 6a78834b65898919281068853276703f0feea886 Mon Sep 17 00:00:00 2001 From: Christopher Pahl Date: Sun, 12 Apr 2015 18:45:37 +0200 Subject: [PATCH] man: add word of warning to --with-metadata-cache --- docs/rmlint.1.rst | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/rmlint.1.rst b/docs/rmlint.1.rst index 7864363f..2bbc92a7 100644 --- a/docs/rmlint.1.rst +++ b/docs/rmlint.1.rst @@ -409,7 +409,16 @@ Rarely used, miscellaneous Options Sometimes the difference may be very subtle since all paths in rmlint are stored by common prefix, i.e. for long but mostly identically paths the - point after the difference is stored. + point after the difference is stored. + + This feature may not play nice with some other options, causing heavy load + and long computations: + + - The ``--match-*`` family of options (long ) + - ``--cache`` might use more memory and takes longer. + - ``--merge-directories`` will not car about using the metadata cache yet. + + Some of those restrictions might be removed in future ``rmlint`` versions. The metadata cache will be stored in ``$XDG_CACHE_HOME/rmlint/$pid``. If the cache cannot be created, ``rmlint`` falls back to no caching mode.