diff options
Diffstat (limited to 'documentation/README')
| -rw-r--r-- | documentation/README | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/documentation/README b/documentation/README index b60472fcbf..a7138c40e2 100644 --- a/documentation/README +++ b/documentation/README | |||
| @@ -165,6 +165,14 @@ To run Vale: | |||
| 165 | 165 | ||
| 166 | $ make stylecheck | 166 | $ make stylecheck |
| 167 | 167 | ||
| 168 | Style checking the whole documentation might take some time and generate a | ||
| 169 | lot of warnings/errors, thus one can run Vale on a subset of files or | ||
| 170 | directories: | ||
| 171 | |||
| 172 | $ make stylecheck VALEDOCS=<file> | ||
| 173 | $ make stylecheck VALEDOCS="<file1> <file2>" | ||
| 174 | $ make stylecheck VALEDOCS=<dir> | ||
| 175 | |||
| 168 | Link checking the Yocto Project documentation | 176 | Link checking the Yocto Project documentation |
| 169 | ============================================= | 177 | ============================================= |
| 170 | 178 | ||
