| Message ID | 20210101204325.998256-1-j.neuschaefer@gmx.net |
|---|---|
| State | Accepted |
| Commit | e1d4d6633816d39e433154499bc4b9b5ee2b2258 |
| Headers | show |
| Series | docs: gpio: intro: Improve HTML formatting | expand |
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
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
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(-) -- 2.29.2