[PATCH v1] gpiolib: Update indentation in driver.rst for code excerpts

[PATCH v1] gpiolib: Update indentation in driver.rst for code excerpts

[Andy Shevchenko]

When TABs are being used to indent the code excerpts inside
the bullet lists some of the tools fail to recognize it and
continue interpreting the special characters inside
the quoted excerpt.

Update indentation in driver.rst for code excerpts to avoid
their special interpretation.

Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
---
 Documentation/driver-api/gpio/driver.rst | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/Documentation/driver-api/gpio/driver.rst b/Documentation/driver-api/gpio/driver.rst
index 9809f593c0ab..072a7455044e 100644
--- a/Documentation/driver-api/gpio/driver.rst
+++ b/Documentation/driver-api/gpio/driver.rst
@@ -342,12 +342,12 @@ Cascaded GPIO irqchips usually fall in one of three categories:
   forced to a thread. The "fake?" raw lock can be used to work around this
   problem::
 
-	raw_spinlock_t wa_lock;
-	static irqreturn_t omap_gpio_irq_handler(int irq, void *gpiobank)
-		unsigned long wa_lock_flags;
-		raw_spin_lock_irqsave(&bank->wa_lock, wa_lock_flags);
-		generic_handle_irq(irq_find_mapping(bank->chip.irq.domain, bit));
-		raw_spin_unlock_irqrestore(&bank->wa_lock, wa_lock_flags);
+    raw_spinlock_t wa_lock;
+    static irqreturn_t omap_gpio_irq_handler(int irq, void *gpiobank)
+        unsigned long wa_lock_flags;
+        raw_spin_lock_irqsave(&bank->wa_lock, wa_lock_flags);
+        generic_handle_irq(irq_find_mapping(bank->chip.irq.domain, bit));
+        raw_spin_unlock_irqrestore(&bank->wa_lock, wa_lock_flags);
 
 - GENERIC CHAINED GPIO IRQCHIPS: these are the same as "CHAINED GPIO irqchips",
   but chained IRQ handlers are not used. Instead GPIO IRQs dispatching is
-- 
2.28.0

Re: [PATCH v1] gpiolib: Update indentation in driver.rst for code excerpts

[Jonathan Corbet]

On Wed,  7 Oct 2020 17:38:17 +0300
Andy Shevchenko <andriy.shevchenko@linux.intel.com> wrote:

> When TABs are being used to indent the code excerpts inside
> the bullet lists some of the tools fail to recognize it and
> continue interpreting the special characters inside
> the quoted excerpt.

Which tools are those?  The docs build itself seems to work fine...?

Thanks,

jon

Re: [PATCH v1] gpiolib: Update indentation in driver.rst for code excerpts

[Andy Shevchenko]

On Thu, Oct 8, 2020 at 6:10 PM Jonathan Corbet <corbet@lwn.net> wrote:
>
> On Wed,  7 Oct 2020 17:38:17 +0300
> Andy Shevchenko <andriy.shevchenko@linux.intel.com> wrote:
>
> > When TABs are being used to indent the code excerpts inside
> > the bullet lists some of the tools fail to recognize it and
> > continue interpreting the special characters inside
> > the quoted excerpt.
>
> Which tools are those?  The docs build itself seems to work fine...?

vim


-- 
With Best Regards,
Andy Shevchenko

Re: [PATCH v1] gpiolib: Update indentation in driver.rst for code excerpts

[Jonathan Corbet]

On Wed,  7 Oct 2020 17:38:17 +0300
Andy Shevchenko <andriy.shevchenko@linux.intel.com> wrote:

> When TABs are being used to indent the code excerpts inside
> the bullet lists some of the tools fail to recognize it and
> continue interpreting the special characters inside
> the quoted excerpt.
> 
> Update indentation in driver.rst for code excerpts to avoid
> their special interpretation.
> 
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
> ---

OK, I've applied this.  I added a parenthetical to the changelog
mentioning vim in particular - gotta put the blame where it's due...:)

Thanks,

jon