linux-kernel - Re: [PATCH] docs: driver-api: gpio: Fix some typos

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:   Thu, 23 Jun 2022 23:21:19 +0200
From:   Bartosz Golaszewski <brgl@...ev.pl>
To:     Tom Schwindl <schwindl@...teo.de>
Cc:     Jonathan Corbet <corbet@....net>,
        Linus Walleij <linus.walleij@...aro.org>,
        "open list:GPIO SUBSYSTEM" <linux-gpio@...r.kernel.org>,
        linux-doc <linux-doc@...r.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH] docs: driver-api: gpio: Fix some typos

On Thu, Jun 23, 2022 at 7:49 PM Tom Schwindl <schwindl@...teo.de> wrote:
>

Please add some description here as is customary in kernel git messages.

Bart

> Signed-off-by: Tom Schwindl <schwindl@...teo.de>
> ---
>  Documentation/driver-api/gpio/consumer.rst   | 2 +-
>  Documentation/driver-api/gpio/driver.rst     | 6 +++---
>  Documentation/driver-api/gpio/using-gpio.rst | 2 +-
>  3 files changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/Documentation/driver-api/gpio/consumer.rst b/Documentation/driver-api/gpio/consumer.rst
> index 72bcf5f5e3a2..de6fc79ad6f0 100644
> --- a/Documentation/driver-api/gpio/consumer.rst
> +++ b/Documentation/driver-api/gpio/consumer.rst
> @@ -114,7 +114,7 @@ For a function using multiple GPIOs all of those can be obtained with one call::
>
>  This function returns a struct gpio_descs which contains an array of
>  descriptors.  It also contains a pointer to a gpiolib private structure which,
> -if passed back to get/set array functions, may speed up I/O proocessing::
> +if passed back to get/set array functions, may speed up I/O processing::
>
>         struct gpio_descs {
>                 struct gpio_array *info;
> diff --git a/Documentation/driver-api/gpio/driver.rst b/Documentation/driver-api/gpio/driver.rst
> index 70ff43ac4fcc..6baaeab79534 100644
> --- a/Documentation/driver-api/gpio/driver.rst
> +++ b/Documentation/driver-api/gpio/driver.rst
> @@ -119,7 +119,7 @@ GPIO lines with debounce support
>  Debouncing is a configuration set to a pin indicating that it is connected to
>  a mechanical switch or button, or similar that may bounce. Bouncing means the
>  line is pulled high/low quickly at very short intervals for mechanical
> -reasons. This can result in the value being unstable or irqs fireing repeatedly
> +reasons. This can result in the value being unstable or irqs firing repeatedly
>  unless the line is debounced.
>
>  Debouncing in practice involves setting up a timer when something happens on
> @@ -219,7 +219,7 @@ use a trick: when a line is set as output, if the line is flagged as open
>  drain, and the IN output value is low, it will be driven low as usual. But
>  if the IN output value is set to high, it will instead *NOT* be driven high,
>  instead it will be switched to input, as input mode is high impedance, thus
> -achieveing an "open drain emulation" of sorts: electrically the behaviour will
> +achieving an "open drain emulation" of sorts: electrically the behaviour will
>  be identical, with the exception of possible hardware glitches when switching
>  the mode of the line.
>
> @@ -642,7 +642,7 @@ In this case the typical set-up will look like this:
>
>  As you can see pretty similar, but you do not supply a parent handler for
>  the IRQ, instead a parent irqdomain, an fwnode for the hardware and
> -a funcion .child_to_parent_hwirq() that has the purpose of looking up
> +a function .child_to_parent_hwirq() that has the purpose of looking up
>  the parent hardware irq from a child (i.e. this gpio chip) hardware irq.
>  As always it is good to look at examples in the kernel tree for advice
>  on how to find the required pieces.
> diff --git a/Documentation/driver-api/gpio/using-gpio.rst b/Documentation/driver-api/gpio/using-gpio.rst
> index 64c8d3f76c3a..894d88855d73 100644
> --- a/Documentation/driver-api/gpio/using-gpio.rst
> +++ b/Documentation/driver-api/gpio/using-gpio.rst
> @@ -44,7 +44,7 @@ These devices will appear on the system as ``/dev/gpiochip0`` thru
>  found in the kernel tree ``tools/gpio`` subdirectory.
>
>  For structured and managed applications, we recommend that you make use of the
> -libgpiod_ library. This provides helper abstractions, command line utlities
> +libgpiod_ library. This provides helper abstractions, command line utilities
>  and arbitration for multiple simultaneous consumers on the same GPIO chip.
>
>  .. _libgpiod: https://git.kernel.org/pub/scm/libs/libgpiod/libgpiod.git/
> --
> 2.36.1
>