Is your feature request related to a problem?
PHPCS can cache scan results between scans for faster re-runs using the --cache CLI flag.
The cache can also be enabled via passing the CLI flag from within an XML ruleset.
Aside from in the --help section on the Usage page in the wiki, this feature isn't documented.
Describe the solution you'd like
Either a new section in the Advanced Usage page (or maybe a separate new Wiki page) documenting this feature.
The docs should (at the very least) include information about the difference in cache behaviour between caching to a named file vs caching to the PHP temp directory.
I think it will also be helpful to document when the cache will automatically be vacated.
Additional context
Might also be good to see if - once the section/page is written up -, there are references in the pre-existing wiki docs which can start linking to the new docs. (like the "Requirements" page)
Is your feature request related to a problem?
PHPCS can cache scan results between scans for faster re-runs using the
--cacheCLI flag.The cache can also be enabled via passing the CLI flag from within an XML ruleset.
Aside from in the
--helpsection on the Usage page in the wiki, this feature isn't documented.Describe the solution you'd like
Either a new section in the Advanced Usage page (or maybe a separate new Wiki page) documenting this feature.
The docs should (at the very least) include information about the difference in cache behaviour between caching to a named file vs caching to the PHP temp directory.
I think it will also be helpful to document when the cache will automatically be vacated.
Additional context
Might also be good to see if - once the section/page is written up -, there are references in the pre-existing wiki docs which can start linking to the new docs. (like the "Requirements" page)