Re: [PATCH v2] media: v4l2-fwnode: fix location of acpi/dsd documentation

From: Sakari Ailus
Date: Tue Sep 24 2019 - 08:09:25 EST


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@xxxxxxxxxx>

Acked-by: Sakari Ailus <sakari.ailus@xxxxxxxxxxxxxxx>

> ---
>
> 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@xxxxxxxxxxxxxxx