linux-kernel - Re: [PATCH] docs: driver-api: iio: fix errors in documentation

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: Windows password security audit tool. GUI, reports in PDF.

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

Date:   Sun, 3 Mar 2019 13:11:12 +0000
From:   Jonathan Cameron <jic23@...23.retrosnub.co.uk>
To:     Tomasz Duszynski <tduszyns@...il.com>
Cc:     linux-iio@...r.kernel.org, linux-kernel@...r.kernel.org,
        linux-doc@...r.kernel.org, corbet@....net
Subject: Re: [PATCH] docs: driver-api: iio: fix errors in documentation

On Mon, 25 Feb 2019 21:23:26 +0100
Tomasz Duszynski <tduszyns@...il.com> wrote:

> Improve IIO documentation by fixing a few mistakes.
> 
> Signed-off-by: Tomasz Duszynski <tduszyns@...il.com>
Acked-by: Jonathan Cameron <Jonathan.Cameron@...wei.com>

Thanks,

Jonathan


> ---
>  Documentation/driver-api/iio/buffers.rst     | 2 +-
>  Documentation/driver-api/iio/core.rst        | 6 +++---
>  Documentation/driver-api/iio/hw-consumer.rst | 2 +-
>  Documentation/driver-api/iio/triggers.rst    | 2 +-
>  4 files changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/Documentation/driver-api/iio/buffers.rst b/Documentation/driver-api/iio/buffers.rst
> index 02c99a6bee18..e9036ef9f8f4 100644
> --- a/Documentation/driver-api/iio/buffers.rst
> +++ b/Documentation/driver-api/iio/buffers.rst
> @@ -26,7 +26,7 @@ IIO buffer setup
>  ================
> 
>  The meta information associated with a channel reading placed in a buffer is
> -called a scan element . The important bits configuring scan elements are
> +called a scan element. The important bits configuring scan elements are
>  exposed to userspace applications via the
>  :file:`/sys/bus/iio/iio:device{X}/scan_elements/*` directory. This file contains
>  attributes of the following form:
> diff --git a/Documentation/driver-api/iio/core.rst b/Documentation/driver-api/iio/core.rst
> index 9a34ae03b679..54f193edbf8b 100644
> --- a/Documentation/driver-api/iio/core.rst
> +++ b/Documentation/driver-api/iio/core.rst
> @@ -2,8 +2,8 @@
>  Core elements
>  =============
> 
> -The Industrial I/O core offers a unified framework for writing drivers for
> -many different types of embedded sensors. a standard interface to user space
> +The Industrial I/O core offers both a unified framework for writing drivers for
> +many different types of embedded sensors and a standard interface to user space
>  applications manipulating sensors. The implementation can be found under
>  :file:`drivers/iio/industrialio-*`
> 
> @@ -11,7 +11,7 @@ Industrial I/O Devices
>  ----------------------
> 
>  * struct :c:type:`iio_dev` - industrial I/O device
> -* :c:func:`iio_device_alloc()` - alocate an :c:type:`iio_dev` from a driver
> +* :c:func:`iio_device_alloc()` - allocate an :c:type:`iio_dev` from a driver
>  * :c:func:`iio_device_free()` - free an :c:type:`iio_dev` from a driver
>  * :c:func:`iio_device_register()` - register a device with the IIO subsystem
>  * :c:func:`iio_device_unregister()` - unregister a device from the IIO
> diff --git a/Documentation/driver-api/iio/hw-consumer.rst b/Documentation/driver-api/iio/hw-consumer.rst
> index 8facce6a6733..e0fe0b98230e 100644
> --- a/Documentation/driver-api/iio/hw-consumer.rst
> +++ b/Documentation/driver-api/iio/hw-consumer.rst
> @@ -1,7 +1,7 @@
>  ===========
>  HW consumer
>  ===========
> -An IIO device can be directly connected to another device in hardware. in this
> +An IIO device can be directly connected to another device in hardware. In this
>  case the buffers between IIO provider and IIO consumer are handled by hardware.
>  The Industrial I/O HW consumer offers a way to bond these IIO devices without
>  software buffer for data. The implementation can be found under
> diff --git a/Documentation/driver-api/iio/triggers.rst b/Documentation/driver-api/iio/triggers.rst
> index f89d37e7dd82..5c2156de6284 100644
> --- a/Documentation/driver-api/iio/triggers.rst
> +++ b/Documentation/driver-api/iio/triggers.rst
> @@ -38,7 +38,7 @@ There are two locations in sysfs related to triggers:
> 
>  * :file:`/sys/bus/iio/devices/iio:device{X}/trigger/*`, this directory is
>    created once the device supports a triggered buffer. We can associate a
> -  trigger with our  device by writing the trigger's name in the
> +  trigger with our device by writing the trigger's name in the
>    :file:`current_trigger` file.
> 
>  IIO trigger setup
> --
> 2.20.1
>