diff mbox series

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

Message ID 32b0db7e79a3ed0e817213113c607a1b819e3867.1622898327.git.mchehab+huawei@kernel.org (mailing list archive)
State Accepted
Headers show
Series docs: avoid using ReST :doc:`foo` tag | expand

Commit Message

Mauro Carvalho Chehab June 5, 2021, 1:18 p.m. UTC
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 <mchehab+huawei@kernel.org>
---
 Documentation/hwmon/adm1177.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Comments

Guenter Roeck June 6, 2021, 1:01 p.m. UTC | #1
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 <mchehab+huawei@kernel.org>

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
diff mbox series

Patch

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