diff options
author | Julien Stephan <jstephan@baylibre.com> | 2024-11-04 16:59:12 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2024-11-07 10:12:23 +0000 |
commit | 7d88e832b5ee4f25d1c50c1e24781ef83670f05d (patch) | |
tree | a68117695625fd729f1ed28d091ed57e1daee2be /documentation | |
parent | 965231995e961a1e7242ee0b5364c8ee615940e5 (diff) | |
download | poky-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/README | 8 |
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 | ||
145 | Style checking the whole documentation might take some time and generate a | ||
146 | lot of warnings/errors, thus one can run Vale on a subset of files or | ||
147 | directories: | ||
148 | |||
149 | $ make stylecheck VALEDOCS=<file> | ||
150 | $ make stylecheck VALEDOCS="<file1> <file2>" | ||
151 | $ make stylecheck VALEDOCS=<dir> | ||
152 | |||
145 | Link checking the Yocto Project documentation | 153 | Link checking the Yocto Project documentation |
146 | ============================================= | 154 | ============================================= |
147 | 155 | ||