Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <cbeb2bdc-4a36-1f9a-e28f-842773b6a161@collabora.com>
Date:   Thu, 3 Nov 2022 10:19:15 +0100
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101
 Thunderbird/102.3.3
Subject: Re: [PATCH] docs: dt: writing-schema: Document usage of CHECK_DTBS
 make flag
Content-Language: en-US
To:     =?UTF-8?B?TsOtY29sYXMgRi4gUi4gQS4gUHJhZG8=?= 
        <nfraprado@collabora.com>, Rob Herring <robh+dt@kernel.org>
Cc:     kernel@collabora.com,
        Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
        Matthias Brugger <matthias.bgg@gmail.com>,
        devicetree@vger.kernel.org, linux-arm-kernel@lists.infradead.org,
        linux-kernel@vger.kernel.org, linux-mediatek@lists.infradead.org
References: <20221102214300.309347-1-nfraprado@collabora.com>
From:   AngeloGioacchino Del Regno 
        <angelogioacchino.delregno@collabora.com>
In-Reply-To: <20221102214300.309347-1-nfraprado@collabora.com>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 8bit
Precedence: bulk

Il 02/11/22 22:43, Nícolas F. R. A. Prado ha scritto:
> It is possible to run checks on a Devicetree by passing the CHECK_DTBS
> flag when building. This is a useful shortcut to the dtbs_check make
> target since it avoids checking unrelated Devicetrees, which can take
> some time and is unnecessary if no bindings were modified. Document it.
> 
> Signed-off-by: Nícolas F. R. A. Prado <nfraprado@collabora.com>
>  > ---
> 
>   Documentation/devicetree/bindings/writing-schema.rst | 7 +++++++
>   1 file changed, 7 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/writing-schema.rst b/Documentation/devicetree/bindings/writing-schema.rst
> index 4a381d20f2b4..55ad556472b4 100644
> --- a/Documentation/devicetree/bindings/writing-schema.rst
> +++ b/Documentation/devicetree/bindings/writing-schema.rst
> @@ -167,6 +167,13 @@ setting the ``DT_SCHEMA_FILES`` variable to a specific schema file or pattern.
>       make dt_binding_check DT_SCHEMA_FILES=/gpio/
>       make dtbs_check DT_SCHEMA_FILES=trivial-devices.yaml
>   
> +Note that ``make dtbs_check`` will validate every DT source file that is

"Note that xxxx" looks a bit repeated... read:

Note that ``dtbs_check`` will skip any binding schema files with errors.
(etc etc)

Note that ``make dtbs_check`` will validate every DT source file ...
(etc etc)

Perhaps we can change the first paragraph saying
"In order to perform validation of DT source files, use..."
to something like:

In order to perform validation of all DT source files, use the ``dtbs_check``
target, or set the ``CHECK_DTBS`` variable to ``y`` when building specific DTs::

::

     make dtbs_check
     make CHECK_DTBS=y mediatek/mt8192-evb.dtb

Any opinion?

Cheers,
Angelo