Skip to content

Commit 8cf9754

Browse files
committed
update configuration guide
1 parent 574e169 commit 8cf9754

File tree

1 file changed

+24
-8
lines changed

1 file changed

+24
-8
lines changed

docs/configuration.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,14 @@
99
4. [Show Warnings](#show-warnings)
1010
5. [Jobs](#jobs)
1111
6. [Cache](#cache)
12-
7. [No caching](#no-caching)
13-
8. [Memory limit](#memory-limit)
14-
9. [JSON output](#json-output)
15-
10. [Junit output](#junit-output)
16-
11. [Checkstyle output](#checkstyle-output)
17-
12. [SARIF output](#sarif-output)
18-
13. [Exit Code](#exit-code)
12+
7. [Cache invalidation](#cache-ttl)
13+
8. [No caching](#no-caching)
14+
9. [Memory limit](#memory-limit)
15+
10. [JSON output](#json-output)
16+
11. [Junit output](#junit-output)
17+
12. [Checkstyle output](#checkstyle-output)
18+
13. [SARIF output](#sarif-output)
19+
14. [Exit Code](#exit-code)
1920

2021
The `phplint` command relies on a configuration file for loading settings.
2122
If a configuration file is not specified through the `--configuration|-c` option, following file will be used : `.phplint.yml`.
@@ -60,7 +61,22 @@ This setting is used only when the `cache-adapter` is set to `Filesystem` value
6061
If you don't want to store results in a sub-folder of your working directory, please specify an absolute path.
6162
For example: `/tmp/my-phplint-cache`
6263

63-
NOTE: if you give an empty `cache` setting value, default directory used will be `/tmp/symfony-cache` (See [Symfony Cache component][symfony/cache])
64+
> [!NOTE]
65+
>
66+
> if you give an empty `cache` setting value, default directory used will be `/tmp/symfony-cache` (See [Symfony Cache component][symfony/cache])
67+
68+
> [!IMPORTANT]
69+
>
70+
> The option `cache` is deprecated and will be removed in version 10, use 'cache-dir' instead.
71+
72+
## Cache invalidation
73+
74+
The `cache-ttl` (`int`|`string` default `3600` seconds => 1 hour) setting was introduced on version 9.6
75+
to limit cache life of files syntax checking results.
76+
77+
> [!CAUTION]
78+
>
79+
> On previous versions, caching results were permanently stored.
6480
6581
## No caching
6682

0 commit comments

Comments
 (0)