conf: add a comment about obsolete .cache file

1 files changed, 3 insertions, 0 deletions

diff --git a/doc/example.conf.in b/doc/example.conf.in
index fbb9271f..a0850146 100644
--- a/doc/example.conf.in
+++ b/doc/example.conf.in
@@ -86,6 +86,9 @@ devices {
     # It is safe to delete the contents: the tools regenerate it.
     # (The old setting 'cache' is still respected if neither of
     # these new ones is present.)
+    # N.B. This type of caching is obsolete and existing .cache
+    # file is removed if the list of devices is obtained from
+    # udev by setting the obtain_device_list_from_udev to 1.
     cache_dir = "@DEFAULT_SYS_DIR@/@DEFAULT_CACHE_SUBDIR@"
     cache_file_prefix = ""