* [PATCH] docs: gpio: intro: Improve HTML formatting
@ 2021-01-01 20:43 Jonathan Neuschäfer
2021-01-03 15:28 ` Bartosz Golaszewski
0 siblings, 1 reply; 2+ messages in thread
From: Jonathan Neuschäfer @ 2021-01-01 20:43 UTC (permalink / raw)
To: linux-doc
Cc: Jonathan Neuschäfer, Linus Walleij, Bartosz Golaszewski,
Jonathan Corbet, linux-gpio, linux-kernel
Currently the HTML output for Documentation/driver-api/gpio/intro.rst
doesn't look right. The lines that start with LOW or HIGH are formatted
in bold, while the next line after each is not bold.
With this patch, the HTML looks better.
Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---
Documentation/driver-api/gpio/intro.rst | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/Documentation/driver-api/gpio/intro.rst b/Documentation/driver-api/gpio/intro.rst
index 74591489d0b55..94dd7185e76eb 100644
--- a/Documentation/driver-api/gpio/intro.rst
+++ b/Documentation/driver-api/gpio/intro.rst
@@ -106,11 +106,11 @@ don't. When you need open drain signaling but your hardware doesn't directly
support it, there's a common idiom you can use to emulate it with any GPIO pin
that can be used as either an input or an output:
- LOW: gpiod_direction_output(gpio, 0) ... this drives the signal and overrides
- the pullup.
+ **LOW**: ``gpiod_direction_output(gpio, 0)`` ... this drives the signal and
+ overrides the pullup.
- HIGH: gpiod_direction_input(gpio) ... this turns off the output, so the pullup
- (or some other device) controls the signal.
+ **HIGH**: ``gpiod_direction_input(gpio)`` ... this turns off the output, so
+ the pullup (or some other device) controls the signal.
The same logic can be applied to emulate open source signaling, by driving the
high signal and configuring the GPIO as input for low. This open drain/open
--
2.29.2
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] docs: gpio: intro: Improve HTML formatting
2021-01-01 20:43 [PATCH] docs: gpio: intro: Improve HTML formatting Jonathan Neuschäfer
@ 2021-01-03 15:28 ` Bartosz Golaszewski
0 siblings, 0 replies; 2+ messages in thread
From: Bartosz Golaszewski @ 2021-01-03 15:28 UTC (permalink / raw)
To: Jonathan Neuschäfer
Cc: linux-doc, Linus Walleij, Jonathan Corbet, linux-gpio, LKML
On Fri, Jan 1, 2021 at 9:43 PM Jonathan Neuschäfer
<j.neuschaefer@gmx.net> wrote:
>
> Currently the HTML output for Documentation/driver-api/gpio/intro.rst
> doesn't look right. The lines that start with LOW or HIGH are formatted
> in bold, while the next line after each is not bold.
>
> With this patch, the HTML looks better.
>
> Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
> ---
> Documentation/driver-api/gpio/intro.rst | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/Documentation/driver-api/gpio/intro.rst b/Documentation/driver-api/gpio/intro.rst
> index 74591489d0b55..94dd7185e76eb 100644
> --- a/Documentation/driver-api/gpio/intro.rst
> +++ b/Documentation/driver-api/gpio/intro.rst
> @@ -106,11 +106,11 @@ don't. When you need open drain signaling but your hardware doesn't directly
> support it, there's a common idiom you can use to emulate it with any GPIO pin
> that can be used as either an input or an output:
>
> - LOW: gpiod_direction_output(gpio, 0) ... this drives the signal and overrides
> - the pullup.
> + **LOW**: ``gpiod_direction_output(gpio, 0)`` ... this drives the signal and
> + overrides the pullup.
>
> - HIGH: gpiod_direction_input(gpio) ... this turns off the output, so the pullup
> - (or some other device) controls the signal.
> + **HIGH**: ``gpiod_direction_input(gpio)`` ... this turns off the output, so
> + the pullup (or some other device) controls the signal.
>
> The same logic can be applied to emulate open source signaling, by driving the
> high signal and configuring the GPIO as input for low. This open drain/open
> --
> 2.29.2
>
Applied, thanks!
Bartosz
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2021-01-03 15:29 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-01-01 20:43 [PATCH] docs: gpio: intro: Improve HTML formatting Jonathan Neuschäfer
2021-01-03 15:28 ` Bartosz Golaszewski
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.