LinuxLists.cc - [PATCH 12/17] gpio: gpiolib.c: fix a doc warning

2020-03-17 14:56:56

Subject: [PATCH 12/17] gpio: gpiolib.c: fix a doc warning

Use a different markup for the ERR_PTR, as %FOO doesn't work
if there are parenthesis. So, use, instead:

``ERR_PTR(-EINVAL)``

This fixes the following warning:

./drivers/gpio/gpiolib.c:139: WARNING: Inline literal start-string without end-string.

Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
drivers/gpio/gpiolib.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/gpio/gpiolib.c b/drivers/gpio/gpiolib.c
index f31b1d46599e..74d8973025da 100644
--- a/drivers/gpio/gpiolib.c
+++ b/drivers/gpio/gpiolib.c
@@ -136,7 +136,7 @@ EXPORT_SYMBOL_GPL(gpio_to_desc);
* @hwnum: hardware number of the GPIO for this chip
*
* Returns:
- * A pointer to the GPIO descriptor or %ERR_PTR(-EINVAL) if no GPIO exists
+ * A pointer to the GPIO descriptor or ``ERR_PTR(-EINVAL)`` if no GPIO exists
* in the given chip for the specified hardware number.
*/
struct gpio_desc *gpiochip_get_desc(struct gpio_chip *chip,
--
2.24.1

2020-03-18 09:16:09

by Bartosz Golaszewski

[permalink] [raw]

Subject: Re: [PATCH 12/17] gpio: gpiolib.c: fix a doc warning

wt., 17 mar 2020 o 15:54 Mauro Carvalho Chehab
<[email protected]> napisał(a):
>
> Use a different markup for the ERR_PTR, as %FOO doesn't work
> if there are parenthesis. So, use, instead:
>
> ``ERR_PTR(-EINVAL)``
>
> This fixes the following warning:
>
> ./drivers/gpio/gpiolib.c:139: WARNING: Inline literal start-string without end-string.
>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
> ---
> drivers/gpio/gpiolib.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/gpio/gpiolib.c b/drivers/gpio/gpiolib.c
> index f31b1d46599e..74d8973025da 100644
> --- a/drivers/gpio/gpiolib.c
> +++ b/drivers/gpio/gpiolib.c
> @@ -136,7 +136,7 @@ EXPORT_SYMBOL_GPL(gpio_to_desc);
> * @hwnum: hardware number of the GPIO for this chip
> *
> * Returns:
> - * A pointer to the GPIO descriptor or %ERR_PTR(-EINVAL) if no GPIO exists
> + * A pointer to the GPIO descriptor or ``ERR_PTR(-EINVAL)`` if no GPIO exists
> * in the given chip for the specified hardware number.
> */
> struct gpio_desc *gpiochip_get_desc(struct gpio_chip *chip,
> --
> 2.24.1
>

Reviewed-by: Bartosz Golaszewski <[email protected]>

2020-03-27 10:25:03

by Linus Walleij

[permalink] [raw]

Subject: Re: [PATCH 12/17] gpio: gpiolib.c: fix a doc warning

On Tue, Mar 17, 2020 at 3:54 PM Mauro Carvalho Chehab
<[email protected]> wrote:

> Use a different markup for the ERR_PTR, as %FOO doesn't work
> if there are parenthesis. So, use, instead:
>
> ``ERR_PTR(-EINVAL)``
>
> This fixes the following warning:
>
> ./drivers/gpio/gpiolib.c:139: WARNING: Inline literal start-string without end-string.
>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>

Reviewed-by: Linus Walleij <[email protected]>

Mauro are you merging this or do you want me to merge it?

Yours,
Linus Walleij

2020-03-27 13:47:53

by Mauro Carvalho Chehab

[permalink] [raw]

Subject: Re: [PATCH 12/17] gpio: gpiolib.c: fix a doc warning

Em Fri, 27 Mar 2020 11:22:52 +0100
Linus Walleij <[email protected]> escreveu:

> On Tue, Mar 17, 2020 at 3:54 PM Mauro Carvalho Chehab
> <[email protected]> wrote:
>
> > Use a different markup for the ERR_PTR, as %FOO doesn't work
> > if there are parenthesis. So, use, instead:
> >
> > ``ERR_PTR(-EINVAL)``
> >
> > This fixes the following warning:
> >
> > ./drivers/gpio/gpiolib.c:139: WARNING: Inline literal start-string without end-string.
> >
> > Signed-off-by: Mauro Carvalho Chehab <[email protected]>
>
> Reviewed-by: Linus Walleij <[email protected]>
>
> Mauro are you merging this or do you want me to merge it?

Feel free to merge it.

My plan is to rebase my trees after the merge window, re-sending
anything that got missed for them to be either applied directly
or via the docs tree.

Thanks,
Mauro

2020-03-27 19:27:37

by Linus Walleij

[permalink] [raw]