diff mbox series

[v2,14/29] docs: driver-api: gpio: using-gpio.rst: avoid using ReST :doc:`foo` markup

Message ID 506a41353937c455c2e79b5960b0976edc8aa9e9.1623824363.git.mchehab+huawei@kernel.org
State Accepted
Commit 85aa9afd7bf1b239480dd73d5535978b99300fe7
Headers show
Series None | expand

Commit Message

Mauro Carvalho Chehab June 16, 2021, 6:27 a.m. UTC
The :doc:`foo` tag is auto-generated via automarkup.py.
So, use the filename at the sources, instead of :doc:`foo`.

Reviewed-by: Linus Walleij <linus.walleij@linaro.org>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/driver-api/gpio/using-gpio.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Bartosz Golaszewski June 25, 2021, 10:37 a.m. UTC | #1
On Wed, Jun 16, 2021 at 8:27 AM Mauro Carvalho Chehab
<mchehab+huawei@kernel.org> wrote:
>

> The :doc:`foo` tag is auto-generated via automarkup.py.

> So, use the filename at the sources, instead of :doc:`foo`.

>

> Reviewed-by: Linus Walleij <linus.walleij@linaro.org>

> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

> ---

>  Documentation/driver-api/gpio/using-gpio.rst | 4 ++--

>  1 file changed, 2 insertions(+), 2 deletions(-)

>

> diff --git a/Documentation/driver-api/gpio/using-gpio.rst b/Documentation/driver-api/gpio/using-gpio.rst

> index dda069444032..64c8d3f76c3a 100644

> --- a/Documentation/driver-api/gpio/using-gpio.rst

> +++ b/Documentation/driver-api/gpio/using-gpio.rst

> @@ -9,13 +9,13 @@ with them.

>

>  For examples of already existing generic drivers that will also be good

>  examples for any other kernel drivers you want to author, refer to

> -:doc:`drivers-on-gpio`

> +Documentation/driver-api/gpio/drivers-on-gpio.rst

>

>  For any kind of mass produced system you want to support, such as servers,

>  laptops, phones, tablets, routers, and any consumer or office or business goods

>  using appropriate kernel drivers is paramount. Submit your code for inclusion

>  in the upstream Linux kernel when you feel it is mature enough and you will get

> -help to refine it, see :doc:`../../process/submitting-patches`.

> +help to refine it, see Documentation/process/submitting-patches.rst.

>

>  In Linux GPIO lines also have a userspace ABI.

>

> --

> 2.31.1

>


Applied, thanks!

Bartosz
diff mbox series

Patch

diff --git a/Documentation/driver-api/gpio/using-gpio.rst b/Documentation/driver-api/gpio/using-gpio.rst
index dda069444032..64c8d3f76c3a 100644
--- a/Documentation/driver-api/gpio/using-gpio.rst
+++ b/Documentation/driver-api/gpio/using-gpio.rst
@@ -9,13 +9,13 @@  with them.
 
 For examples of already existing generic drivers that will also be good
 examples for any other kernel drivers you want to author, refer to
-:doc:`drivers-on-gpio`
+Documentation/driver-api/gpio/drivers-on-gpio.rst
 
 For any kind of mass produced system you want to support, such as servers,
 laptops, phones, tablets, routers, and any consumer or office or business goods
 using appropriate kernel drivers is paramount. Submit your code for inclusion
 in the upstream Linux kernel when you feel it is mature enough and you will get
-help to refine it, see :doc:`../../process/submitting-patches`.
+help to refine it, see Documentation/process/submitting-patches.rst.
 
 In Linux GPIO lines also have a userspace ABI.