summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--documentation/README8
1 files changed, 8 insertions, 0 deletions
diff --git a/documentation/README b/documentation/README
index c888b666a8..8ac8d52367 100644
--- a/documentation/README
+++ b/documentation/README
@@ -142,6 +142,14 @@ To run Vale:
142 142
143 $ make stylecheck 143 $ make stylecheck
144 144
145Style checking the whole documentation might take some time and generate a
146lot of warnings/errors, thus one can run Vale on a subset of files or
147directories:
148
149 $ make stylecheck VALEDOCS=<file>
150 $ make stylecheck VALEDOCS="<file1> <file2>"
151 $ make stylecheck VALEDOCS=<dir>
152
145Link checking the Yocto Project documentation 153Link checking the Yocto Project documentation
146============================================= 154=============================================
147 155