All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Cameron <jic23@kernel.org>
To: William Breathitt Gray <vilhelm.gray@gmail.com>,
	knaack.h@gmx.de, lars@metafoo.de, pmeerw@pmeerw.net
Cc: linux-iio@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] iio: Fix typos in the struct iio_event_spec documentation comments
Date: Wed, 17 Feb 2016 21:11:41 +0000	[thread overview]
Message-ID: <56C4E20D.9080508@kernel.org> (raw)
In-Reply-To: <20160215174742.GA9872@sophia>

On 15/02/16 17:47, William Breathitt Gray wrote:
> This patch fixes a few minor typos in the documentation comments for the
> scan_type member of the iio_event_spec structure. The sign member name
> was improperly capitalized as "Sign" in the comments. The storagebits
> member name was improperly listed as "storage_bits" in the comments. The
> endianness member entry in the comments was moved after the repeat
> member entry in order to maintain consistency with the actual struct
> iio_event_spec layout.
> 
> Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com>
Applied to the togreg branch of iio.git - initially pushed out as
testing for the autobuilders to play with it.

Thanks,

Jonathan
> ---
>  include/linux/iio/iio.h | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/include/linux/iio/iio.h b/include/linux/iio/iio.h
> index ce9e9c1..b2b1677 100644
> --- a/include/linux/iio/iio.h
> +++ b/include/linux/iio/iio.h
> @@ -180,18 +180,18 @@ struct iio_event_spec {
>   * @address:		Driver specific identifier.
>   * @scan_index:		Monotonic index to give ordering in scans when read
>   *			from a buffer.
> - * @scan_type:		Sign:		's' or 'u' to specify signed or unsigned
> + * @scan_type:		sign:		's' or 'u' to specify signed or unsigned
>   *			realbits:	Number of valid bits of data
> - *			storage_bits:	Realbits + padding
> + *			storagebits:	Realbits + padding
>   *			shift:		Shift right by this before masking out
>   *					realbits.
> - *			endianness:	little or big endian
>   *			repeat:		Number of times real/storage bits
>   *					repeats. When the repeat element is
>   *					more than 1, then the type element in
>   *					sysfs will show a repeat value.
>   *					Otherwise, the number of repetitions is
>   *					omitted.
> + *			endianness:	little or big endian
>   * @info_mask_separate: What information is to be exported that is specific to
>   *			this channel.
>   * @info_mask_shared_by_type: What information is to be exported that is shared
> 


      reply	other threads:[~2016-02-17 21:11 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-02-15 17:47 [PATCH] iio: Fix typos in the struct iio_event_spec documentation comments William Breathitt Gray
2016-02-17 21:11 ` Jonathan Cameron [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=56C4E20D.9080508@kernel.org \
    --to=jic23@kernel.org \
    --cc=knaack.h@gmx.de \
    --cc=lars@metafoo.de \
    --cc=linux-iio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=pmeerw@pmeerw.net \
    --cc=vilhelm.gray@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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.