From 71ae64c4c353fe41e4d01e958e456daa861623c1 Mon Sep 17 00:00:00 2001 From: "Nicholas C. Zakas" Date: Sat, 23 Jul 2016 08:28:53 -0700 Subject: [PATCH] Docs: Clarify cache file deletion (fixes #4943) (#6712) --- docs/user-guide/command-line-interface.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/user-guide/command-line-interface.md b/docs/user-guide/command-line-interface.md index b16d9791cf9..5302b54a134 100644 --- a/docs/user-guide/command-line-interface.md +++ b/docs/user-guide/command-line-interface.md @@ -169,7 +169,9 @@ Examples: #### `--cache` -Store the info about processed files in order to only operate on the changed ones. +Store the info about processed files in order to only operate on the changed ones. The cache is stored in `.eslintcache` by default. Enabling this option can dramatically improve ESLint's running time by ensuring that only changed files are linted. + +**Note:** If you run ESLint with `--cache` and then run ESLint without `--cache`, the `.eslintcache` file will be deleted. This is necessary because the results of the lint might change and make `.eslintcache` invalid. If you want to control when the cache file is deleted, then use `--cache-location` to specify an alternate location for the cache file. #### `--cache-file`