Skip to content

Commit 5a6c8a5

Browse files
author
Vincent Faliès
committed
Update README.md
1 parent 0f6dbe6 commit 5a6c8a5

File tree

1 file changed

+45
-3
lines changed

1 file changed

+45
-3
lines changed

README.md

Lines changed: 45 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This container propose to check the compatibility of your code with PHP 7.x
1010
docker run --rm -v $(pwd):/app vfac/php7compatibility <version> <option> <path>
1111
```
1212

13-
### \<version>
13+
### <version>
1414

1515
PHP Version used to check code compatibility: 7.0, 7.1, 7.2
1616

@@ -20,7 +20,9 @@ For instance to check code of the current directory in PHP version 7.1 :
2020
docker run --rm -v $(pwd):/app vfac/php7compatibility 7.1 .
2121
```
2222

23-
### \<option>
23+
### <option>
24+
25+
#### memory_limit
2426

2527
With large source code, you could have an error message like:
2628

@@ -42,7 +44,47 @@ With a setting to 1Giga of memory:
4244
docker run --rm -v $(pwd):/app php7compatibility 7.2 -d memory_limit=1G .
4345
```
4446

45-
### \<path>
47+
#### File extensions
48+
49+
You can limit the inspection of your code to specific extension file with the optiion
50+
51+
```
52+
--extensions=php
53+
```
54+
55+
Several extensions can be add, with a comma separation
56+
57+
```
58+
--extensions=php,lib
59+
```
60+
61+
Exemple
62+
63+
```
64+
docker run --rm -v $(pwd):/app vfac/php7compatibility 7.1 --extensions=php .
65+
```
66+
67+
#### Ignoring files and folders
68+
69+
The `--ignore` option can be useful to prevent a big scan of your code.
70+
71+
```
72+
--ignore=vendor
73+
```
74+
75+
Several paths can be add, with a comma separation
76+
77+
```
78+
--ignore=vendor,tmp
79+
```
80+
81+
Exemple
82+
83+
```
84+
docker run --rm -v $(pwd):/app vfac/php7compatibility 7.1 --ignore=vendor .
85+
```
86+
87+
### <path>
4688

4789
Path to inspect into current directory. To inspect all files in current directory use `.`
4890

0 commit comments

Comments
 (0)