linux-kernel - Re: [PATCH 3/8] docs: dt: writing-schema: Include the example schema in the doc build

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20210325185206.73f8ba1c@coco.lan>
Date:   Thu, 25 Mar 2021 18:52:06 +0100
From:   Mauro Carvalho Chehab <mchehab@...nel.org>
To:     Rob Herring <robh@...nel.org>
Cc:     devicetree@...r.kernel.org, linux-kernel@...r.kernel.org,
        Frank Rowand <frowand.list@...il.com>,
        Lee Jones <lee.jones@...aro.org>,
        Jonathan Corbet <corbet@....net>, linux-doc@...r.kernel.org
Subject: Re: [PATCH 3/8] docs: dt: writing-schema: Include the example
 schema in the doc build

Em Thu, 25 Mar 2021 10:47:08 -0600
Rob Herring <robh@...nel.org> escreveu:

> The example-schema.yaml file serves as documentation, so let's include it
> from writing-schema.rst.
> 
> Cc: Frank Rowand <frowand.list@...il.com>
> Cc: Mauro Carvalho Chehab <mchehab@...nel.org>

Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>

> Signed-off-by: Rob Herring <robh@...nel.org>
> ---
>  Documentation/devicetree/writing-schema.rst | 11 +++++++++++
>  1 file changed, 11 insertions(+)
> 
> diff --git a/Documentation/devicetree/writing-schema.rst b/Documentation/devicetree/writing-schema.rst
> index 03e279d8fd6a..be14dbed6081 100644
> --- a/Documentation/devicetree/writing-schema.rst
> +++ b/Documentation/devicetree/writing-schema.rst
> @@ -8,6 +8,8 @@ written in a JSON compatible subset of YAML. YAML is used instead of JSON as it
>  is considered more human readable and has some advantages such as allowing
>  comments (Prefixed with '#').
>  
> +Also see :ref:`example-schema`.
> +
>  Schema Contents
>  ---------------
>  
> @@ -170,3 +172,12 @@ json-schema Resources
>  `JSON-Schema Specifications <http://json-schema.org/>`_
>  
>  `Using JSON Schema Book <http://usingjsonschema.com/>`_
> +
> +.. _example-schema:
> +
> +Annotated Example Schema
> +------------------------
> +
> +Also available as a separate file: :download:`example-schema.yaml`
> +
> +.. literalinclude:: example-schema.yaml



Thanks,
Mauro