summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorJulien Stephan <jstephan@baylibre.com>2024-11-04 16:59:12 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2024-11-07 10:12:23 +0000
commit7d88e832b5ee4f25d1c50c1e24781ef83670f05d (patch)
treea68117695625fd729f1ed28d091ed57e1daee2be /documentation
parent965231995e961a1e7242ee0b5364c8ee615940e5 (diff)
downloadpoky-7d88e832b5ee4f25d1c50c1e24781ef83670f05d.tar.gz
README: add instruction to run Vale on a subset
make stylecheck runs Vale on the whole documentation which can be long and reports a lot of errors/warnings. We can run Vale on a subset using the VALEDOCS variable, so update documentation to highlight it. (From yocto-docs rev: 262237f72534c983e178231cb6839ed69709c443) Signed-off-by: Julien Stephan <jstephan@baylibre.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Tested-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-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