2021-06-05 13:21:44

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 22/34] docs: hwmon: adm1177.rst: avoid using ReSt :doc:`foo` markup

The :doc:`foo` tag is auto-generated via automarkup.py.
So, use the filename at the sources, instead of :doc:`foo`.

Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/hwmon/adm1177.rst | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Documentation/hwmon/adm1177.rst b/Documentation/hwmon/adm1177.rst
index 471be1e98d6f..1c85a2af92bf 100644
--- a/Documentation/hwmon/adm1177.rst
+++ b/Documentation/hwmon/adm1177.rst
@@ -20,7 +20,8 @@ Usage Notes
-----------

This driver does not auto-detect devices. You will have to instantiate the
-devices explicitly. Please see :doc:`/i2c/instantiating-devices` for details.
+devices explicitly. Please see Documentation/i2c/instantiating-devices.rst
+for details.


Sysfs entries
--
2.31.1


2021-06-06 13:04:29

by Guenter Roeck

[permalink] [raw]
Subject: Re: [PATCH 22/34] docs: hwmon: adm1177.rst: avoid using ReSt :doc:`foo` markup

On Sat, Jun 05, 2021 at 03:18:21PM +0200, Mauro Carvalho Chehab wrote:
> The :doc:`foo` tag is auto-generated via automarkup.py.
> So, use the filename at the sources, instead of :doc:`foo`.
>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>

Applied.

Thanks,
Guenter

> ---
> Documentation/hwmon/adm1177.rst | 3 ++-
> 1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/hwmon/adm1177.rst b/Documentation/hwmon/adm1177.rst
> index 471be1e98d6f..1c85a2af92bf 100644
> --- a/Documentation/hwmon/adm1177.rst
> +++ b/Documentation/hwmon/adm1177.rst
> @@ -20,7 +20,8 @@ Usage Notes
> -----------
>
> This driver does not auto-detect devices. You will have to instantiate the
> -devices explicitly. Please see :doc:`/i2c/instantiating-devices` for details.
> +devices explicitly. Please see Documentation/i2c/instantiating-devices.rst
> +for details.
>
>
> Sysfs entries