2019-09-26 01:16:41

by Mauro Carvalho Chehab

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

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 <[email protected]>
---
drivers/media/v4l2-core/v4l2-fwnode.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/media/v4l2-core/v4l2-fwnode.c b/drivers/media/v4l2-core/v4l2-fwnode.c
index 3bd1888787eb..0e361565f2f9 100644
--- a/drivers/media/v4l2-core/v4l2-fwnode.c
+++ b/drivers/media/v4l2-core/v4l2-fwnode.c
@@ -819,7 +819,7 @@ 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,
+ * Documentation/firmware-guide/acpi/dsd instead and especially graph.txt,
* data-node-references.txt and leds.txt .
*
* Scope (\_SB.PCI0.I2C2)
--
2.21.0

2019-09-26 01:25:16

by Sakari Ailus

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

Hi Mauro,

On Tue, Sep 24, 2019 at 07:36:00AM -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 <[email protected]>
> ---
> drivers/media/v4l2-core/v4l2-fwnode.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/media/v4l2-core/v4l2-fwnode.c b/drivers/media/v4l2-core/v4l2-fwnode.c
> index 3bd1888787eb..0e361565f2f9 100644
> --- a/drivers/media/v4l2-core/v4l2-fwnode.c
> +++ b/drivers/media/v4l2-core/v4l2-fwnode.c
> @@ -819,7 +819,7 @@ 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,
> + * Documentation/firmware-guide/acpi/dsd instead and especially graph.txt,
> * data-node-references.txt and leds.txt .

Thanks! The files now have .rst suffix. Could you address that as well?

With that,

Acked-by: Sakari Ailus <[email protected]>

> *
> * Scope (\_SB.PCI0.I2C2)

--
Kind regards,

Sakari Ailus
[email protected]

2019-09-26 02:02:10

by Mauro Carvalho Chehab

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

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 <[email protected]>
---

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

2019-09-26 08:01:00

by Sakari Ailus

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 <[email protected]>

Acked-by: Sakari Ailus <[email protected]>

> ---
>
> 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
[email protected]