linux-kernel - Re: [PATCH 8/8] docs: dt: Add DT API documentation

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: <20210325185326.431030c8@coco.lan>
Date:   Thu, 25 Mar 2021 18:53:26 +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 8/8] docs: dt: Add DT API documentation

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

> The kernel-doc for the DT APIs are not included in the documentation
> build. Add them.
> 
> 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/index.rst      |  1 +
>  Documentation/devicetree/kernel-api.rst | 57 +++++++++++++++++++++++++
>  2 files changed, 58 insertions(+)
>  create mode 100644 Documentation/devicetree/kernel-api.rst
> 
> diff --git a/Documentation/devicetree/index.rst b/Documentation/devicetree/index.rst
> index 70b5dcdbcf07..1a2fc8014996 100644
> --- a/Documentation/devicetree/index.rst
> +++ b/Documentation/devicetree/index.rst
> @@ -11,6 +11,7 @@ Kernel Devicetree Usage
>  
>     usage-model
>     of_unittest
> +   kernel-api
>  
>  Devicetree Overlays
>  ===================
> diff --git a/Documentation/devicetree/kernel-api.rst b/Documentation/devicetree/kernel-api.rst
> new file mode 100644
> index 000000000000..b7429e6ed6d5
> --- /dev/null
> +++ b/Documentation/devicetree/kernel-api.rst
> @@ -0,0 +1,57 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +.. _devicetree:
> +
> +======================================
> +DeviceTree Kernel API
> +======================================
> +
> +Core functions
> +--------------
> +
> +.. kernel-doc:: drivers/of/base.c
> +   :export:
> +
> +.. kernel-doc:: include/linux/of.h
> +   :internal:
> +
> +.. kernel-doc:: drivers/of/property.c
> +   :export:
> +
> +.. kernel-doc:: include/linux/of_graph.h
> +   :internal:
> +
> +.. kernel-doc:: drivers/of/address.c
> +   :export:
> +
> +.. kernel-doc:: drivers/of/irq.c
> +   :export:
> +
> +.. kernel-doc:: drivers/of/fdt.c
> +   :export:
> +
> +Driver model functions
> +----------------------
> +
> +.. kernel-doc:: include/linux/of_device.h
> +   :internal:
> +
> +.. kernel-doc:: drivers/of/device.c
> +   :export:
> +
> +.. kernel-doc:: include/linux/of_platform.h
> +   :internal:
> +
> +.. kernel-doc:: drivers/of/platform.c
> +   :export:
> +
> +Overlay and Dynamic DT functions
> +--------------------------------
> +
> +.. kernel-doc:: drivers/of/resolver.c
> +   :export:
> +
> +.. kernel-doc:: drivers/of/dynamic.c
> +   :export:
> +
> +.. kernel-doc:: drivers/of/overlay.c
> +   :export:



Thanks,
Mauro