linux-kernel - Re: [PATCH v2] media: v4l2-fwnode: fix location of acpi/dsd 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] [day] [month] [year] [list]

Message-ID: <20190924120918.GI9467@paasikivi.fi.intel.com>
Date:   Tue, 24 Sep 2019 15:09:18 +0300
From:   Sakari Ailus <sakari.ailus@...ux.intel.com>
To:     Mauro Carvalho Chehab <mchehab+samsung@...nel.org>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Mauro Carvalho Chehab <mchehab@...radead.org>,
        linux-kernel@...r.kernel.org, Jonathan Corbet <corbet@....net>,
        Steve Longerbeam <slongerbeam@...il.com>,
        Jacopo Mondi <jacopo+renesas@...ndi.org>,
        Niklas Söderlund 
        <niklas.soderlund+renesas@...natech.se>
Subject: Re: [PATCH v2] media: v4l2-fwnode: fix location of acpi/dsd
 documentation

On Tue, Sep 24, 2019 at 09:03:56AM -0300, Mauro Carvalho Chehab wrote:
> This got moved to the firmware-guide.
> 
> Fixes: f2dde1ed0f28 ("Documentation: ACPI: move dsd/graph.txt to firmware-guide/acpi and convert to reST")
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@...nel.org>

Acked-by: Sakari Ailus <sakari.ailus@...ux.intel.com>

> ---
> 
> v2: 
> 
> - Also replace *.txt -> *.rst. I opted to place the full file names there, as this allows
>   ./scripts/documentation-file-ref-check to check if those files gets renamed. It
>   also helps if some Sphinx would later convert those to hyperlinks (with was
>   already discussed at linux-doc ML, although not implemented yet).
> 
>  drivers/media/v4l2-core/v4l2-fwnode.c | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/media/v4l2-core/v4l2-fwnode.c b/drivers/media/v4l2-core/v4l2-fwnode.c
> index 3bd1888787eb..9387dcba8b59 100644
> --- a/drivers/media/v4l2-core/v4l2-fwnode.c
> +++ b/drivers/media/v4l2-core/v4l2-fwnode.c
> @@ -819,8 +819,10 @@ static int v4l2_fwnode_reference_parse(struct device *dev,
>   *
>   * THIS EXAMPLE EXISTS MERELY TO DOCUMENT THIS FUNCTION. DO NOT USE IT AS A
>   * REFERENCE IN HOW ACPI TABLES SHOULD BE WRITTEN!! See documentation under
> - * Documentation/acpi/dsd instead and especially graph.txt,
> - * data-node-references.txt and leds.txt .
> + * Documentation/firmware-guide/acpi/dsd instead and especially
> + * Documentation/firmware-guide/acpi/dsd/graph.rst,
> + * Documentation/firmware-guide/acpi/dsd/data-node-references.rst and
> + * Documentation/firmware-guide/acpi/dsd/leds.rst.
>   *
>   *	Scope (\_SB.PCI0.I2C2)
>   *	{
> -- 
> 2.21.0
> 
> 

-- 
Sakari Ailus
sakari.ailus@...ux.intel.com