Re: [docs] [PATCH 1/5] README: add instruction to run Vale on a subset

["Antonin Godard" <antonin.godard@bootlin.com>]

Hi Julien,

Thanks for your patches.

On Thu Oct 31, 2024 at 5:56 PM CET, Julien Stephan wrote:
> 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.
>
> Signed-off-by: Julien Stephan <jstephan@baylibre.com>
> ---
>  documentation/README | 7 +++++++
>  1 file changed, 7 insertions(+)
>
> diff --git a/documentation/README b/documentation/README
> index c888b666a8632a1d6f576c68e4f9ca966d79f134..6a4db97d65b9c23828163d8b548485b2e302bc97 100644
> --- a/documentation/README
> +++ b/documentation/README
> @@ -142,6 +142,13 @@ To run Vale:
>  
>   $ make stylecheck
>  
> +Style checking the whole documentation might take some time and generate a
> +lot of warnings/errors, thus one can run Vale on a subset:

s/on a subset:/on a subset of files or directories:/ I would say

> +  $ make stylecheck VALEDOCS=<file>
> +  $ make stylecheck VALEDOCS="<file1> <file2>"
> +  $ make stylecheck VALEDOCS=<dir>
> +
>  Link checking the Yocto Project documentation
>  =============================================
>  

Cheers,
Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com