Skip to contentSkip to conversation

docs: driver-api/gpio/driver.rst: fix code blocks

PATCH In review Stephen Kitt 2 participants 3 messages Mar 12, 2020

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs: driver-api/gpio/driver.rst: fix code blocks

Two code blocks have duplicate declarations (:: and explicit .. code-block), this fixes them, addressing these warnings:

Documentation/driver-api/gpio/driver.rst:425: WARNING: Unexpected indentation. Documentation/driver-api/gpio/driver.rst:423: WARNING: Inline emphasis start-string without end-string. Documentation/driver-api/gpio/driver.rst:427: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/driver-api/gpio/driver.rst:429: WARNING: Inline emphasis start-string without end-string. Documentation/driver-api/gpio/driver.rst:429: WARNING: Inline emphasis start-string without end-string. Documentation/driver-api/gpio/driver.rst:429: WARNING: Inline emphasis start-string without end-string. Documentation/driver-api/gpio/driver.rst:433: WARNING: Inline emphasis start-string without end-string. Documentation/driver-api/gpio/driver.rst:446: WARNING: Unexpected indentation. Documentation/driver-api/gpio/driver.rst:440: WARNING: Inline emphasis start-string without end-string. Documentation/driver-api/gpio/driver.rst:440: WARNING: Inline emphasis start-string without end-string. Documentation/driver-api/gpio/driver.rst:447: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/driver-api/gpio/driver.rst:449: WARNING: Definition list ends without a blank line; unexpected unindent. Documentation/driver-api/gpio/driver.rst:462: WARNING: Unexpected indentation. Documentation/driver-api/gpio/driver.rst:460: WARNING: Inline emphasis start-string without end-string. Documentation/driver-api/gpio/driver.rst:462: WARNING: Inline emphasis start-string without end-string. Documentation/driver-api/gpio/driver.rst:465: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/driver-api/gpio/driver.rst:467: WARNING: Inline emphasis start-string without end-string. Documentation/driver-api/gpio/driver.rst:467: WARNING: Inline emphasis start-string without end-string. Documentation/driver-api/gpio/driver.rst:467: WARNING: Inline emphasis start-string without end-string. Documentation/driver-api/gpio/driver.rst:471: WARNING: Inline emphasis start-string without end-string. Documentation/driver-api/gpio/driver.rst:478: WARNING: Inline emphasis start-string without end-string.

Fixes 4e29b70d5437 ("Documentation: gpio: driver.rst: Fix warnings")
---
 Documentation/driver-api/gpio/driver.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/driver-api/gpio/driver.rst +2 -2
index 871922529332..9809f593c0ab 100644
@@ -416,7 +416,7 @@ The preferred way to set up the helpers is to fill in the
 struct gpio_irq_chip inside struct gpio_chip before adding the gpio_chip.
 If you do this, the additional irq_chip will be set up by gpiolib at the
 same time as setting up the rest of the GPIO functionality. The following
-is a typical example of a cascaded interrupt handler using gpio_irq_chip::
+is a typical example of a cascaded interrupt handler using gpio_irq_chip:
 
 .. code-block:: c
 
@@ -453,7 +453,7 @@ is a typical example of a cascaded interrupt handler using gpio_irq_chip::
   return devm_gpiochip_add_data(dev, &g->gc, g);
 
 The helper support using hierarchical interrupt controllers as well.
-In this case the typical set-up will look like this::
+In this case the typical set-up will look like this:
 
 .. code-block:: c
 

base-commit: 7d3d3254adaa61cba896f71497f56901deb618e5

Signature · 1 line
2.24.1
#1 lore raw

Documentation/driver-api/gpio/driver.rst The preferred way to set up the helpers is to fill in the · line 419

Quoted 2 lines · Stephen Kitt
Documentation/driver-api/gpio/driver.rst +1 -1
-is a typical example of a cascaded interrupt handler using gpio_irq_chip::
+is a typical example of a cascaded interrupt handler using gpio_irq_chip:

Thanks for the patch, but Mauro already fixed it:

https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git/commit/?id=c1c8b1ff0a1985d4992f49a5775bbcf6ee5ccfba

Cheers,
Jonathan Neuschäfer

#2 lore raw
Quoted 8 lines · Jonathan Neuschäfer
Quoted 3 lines · Stephen Kitt

-is a typical example of a cascaded interrupt handler using gpio_irq_chip:: +is a typical example of a cascaded interrupt handler using gpio_irq_chip:

Thanks for the patch, but Mauro already fixed it:

https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git/commit/?id=c1c8b1ff0a1985d4992f49a5775bbcf6ee5ccfba

Ah, yes, I didn’t check linux-next, only docs-next.

Regards,

Stephen