From: Randy Dunlap <rdunlap@infradead.org>
To: linux-kernel@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>,
Jiri Kosina <jikos@kernel.org>,
Benjamin Tissoires <benjamin.tissoires@redhat.com>,
linux-input@vger.kernel.org, Jonathan Cameron <jic23@kernel.org>,
Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>,
linux-iio@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
linux-doc@vger.kernel.org
Subject: [PATCH v2 3/8] Documentation: HID: hiddev editing & corrections
Date: Mon, 28 Dec 2020 12:53:22 -0800 [thread overview]
Message-ID: <20201228205327.1063-4-rdunlap@infradead.org> (raw)
In-Reply-To: <20201228205327.1063-1-rdunlap@infradead.org>
Do basic editing & correction to hiddev.rst:
- use HID instead of hid consistently
- add hyphenation of multi-word adjectives
- drop a duplicate word
- unhyphenate "a priori"
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Jiri Kosina <jikos@kernel.org>
Cc: Benjamin Tissoires <benjamin.tissoires@redhat.com>
Cc: linux-input@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Cc: Jonathan Cameron <jic23@kernel.org>
---
v2: leave hid-core in one place where it might be deliberate. (Jonathan=jic23)
Documentation/hid/hiddev.rst | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
--- lnx-511-rc1.orig/Documentation/hid/hiddev.rst
+++ lnx-511-rc1/Documentation/hid/hiddev.rst
@@ -27,7 +27,7 @@ the following::
--> hiddev.c ----> POWER / MONITOR CONTROL
In addition, other subsystems (apart from USB) can potentially feed
-events into the input subsystem, but these have no effect on the hid
+events into the input subsystem, but these have no effect on the HID
device interface.
Using the HID Device Interface
@@ -73,7 +73,7 @@ The hiddev API uses a read() interface,
HID devices exchange data with the host computer using data
bundles called "reports". Each report is divided into "fields",
each of which can have one or more "usages". In the hid-core,
-each one of these usages has a single signed 32 bit value.
+each one of these usages has a single signed 32-bit value.
read():
-------
@@ -113,7 +113,7 @@ HIDIOCAPPLICATION
- (none)
This ioctl call returns the HID application usage associated with the
-hid device. The third argument to ioctl() specifies which application
+HID device. The third argument to ioctl() specifies which application
index to get. This is useful when the device has more than one
application collection. If the index is invalid (greater or equal to
the number of application collections this device has) the ioctl
@@ -181,7 +181,7 @@ looked up by type (input, output or feat
must be filled in by the user. The ID can be absolute -- the actual
report id as reported by the device -- or relative --
HID_REPORT_ID_FIRST for the first report, and (HID_REPORT_ID_NEXT |
-report_id) for the next report after report_id. Without a-priori
+report_id) for the next report after report_id. Without a priori
information about report ids, the right way to use this ioctl is to
use the relative IDs above to enumerate the valid IDs. The ioctl
returns non-zero when there is no more next ID. The real report ID is
@@ -200,7 +200,7 @@ HIDIOCGUCODE
- struct hiddev_usage_ref (read/write)
Returns the usage_code in a hiddev_usage_ref structure, given that
-given its report type, report id, field index, and index within the
+its report type, report id, field index, and index within the
field have already been filled into the structure.
HIDIOCGUSAGE
next prev parent reply other threads:[~2020-12-28 23:05 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-12-28 20:53 [PATCH v2 0/8] Documentation: HID: edit/correct all files Randy Dunlap
2020-12-28 20:53 ` [PATCH v2 1/8] Documentation: HID: hid-alps editing & corrections Randy Dunlap
2020-12-28 20:53 ` [PATCH v2 2/8] Documentation: HID: amd-sfh-hid " Randy Dunlap
2020-12-28 20:53 ` Randy Dunlap [this message]
2020-12-28 20:53 ` [PATCH v2 4/8] Documentation: HID: intel-ish-hid " Randy Dunlap
2020-12-28 20:53 ` [PATCH v2 5/8] Documentation: HID: hidraw " Randy Dunlap
2020-12-28 20:53 ` [PATCH v2 6/8] Documentation: HID: hid-sensor " Randy Dunlap
2020-12-28 20:53 ` [PATCH v2 7/8] Documentation: HID: hid-transport " Randy Dunlap
2020-12-28 20:53 ` [PATCH v2 8/8] Documentation: HID: uhid " Randy Dunlap
2020-12-29 13:54 ` [PATCH v2 0/8] Documentation: HID: edit/correct all files Jonathan Cameron
2021-01-04 10:51 ` Jiri Kosina
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=20201228205327.1063-4-rdunlap@infradead.org \
--to=rdunlap@infradead.org \
--cc=benjamin.tissoires@redhat.com \
--cc=corbet@lwn.net \
--cc=jic23@kernel.org \
--cc=jikos@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-iio@vger.kernel.org \
--cc=linux-input@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=srinivas.pandruvada@linux.intel.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.