iio: Fix typos in the struct iio_event_spec documentation comments
PATCH 1/1 iio: Fix typos in the struct iio_event_spec documentation comments
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.
--- include/linux/iio/iio.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
include/linux/iio/iio.h +3 -3
@@ -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
Signature · 1 line
2.4.10
Quoted 9 lines · William Breathitt Gray
This patch fixes a few minor typos in the documentation comments for the
scan_typemember of theiio_event_specstructure. 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 structiio_event_speclayout.Signed-off-by William Breathitt Gray <[email protected]>
Applied to the togreg branch of iio.git - initially pushed out as testing for the autobuilders to play with it.
Thanks,
Jonathan
Quoted 31 lines
--- include/linux/iio/iio.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)include/linux/iio/iio.h +3
-3@@ -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