Vegard Nossum
0dfbd35ed4
input: docs: properly format ToC headings
...
"class:: toc-title" was a workaround for older Sphinx versions that are
no longer supported.
The canonical way to add a heading to the ToC is to use :caption:.
Do that.
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com >
Cc: linux-input@vger.kernel.org
Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com >
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
Link: https://lore.kernel.org/r/20231027081830.195056-8-vegard.nossum@oracle.com
2023-11-17 13:05:26 -07:00
Marcus Folkesson
8d58ce1b1e
input: docs: pxrc: remove reference to phoenix-sim
...
The reference undeniably points to something unrelated nowadays.
Remove it.
Signed-off-by: Marcus Folkesson <marcus.folkesson@gmail.com >
Suggested-by: Mark Olsson <mark@markolsson.se >
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
Link: https://lore.kernel.org/r/20230824-pxrc-doc-v1-1-038b75a2ef05@gmail.com
2023-08-28 12:43:32 -06:00
Bjorn Helgaas
d56b699d76
Documentation: Fix typos
...
Fix typos in Documentation.
Signed-off-by: Bjorn Helgaas <bhelgaas@google.com >
Link: https://lore.kernel.org/r/20230814212822.193684-4-helgaas@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2023-08-18 11:29:03 -06:00
Ismael Ferreras Morezuelas
9284d3b9a3
Input: xpad - spelling fixes for "Xbox"
...
The Linux kernel is notorious for misspelling X-Box, X-box, XBox or XBOX;
the official spelling is actually just Xbox. Plain and simple.
Tried to respect the existing notes but still following the style guide.
No functional changes intended. This only affects ancillary parts.
Signed-off-by: Ismael Ferreras Morezuelas <swyterzone@gmail.com >
Link: https://lore.kernel.org/r/401b1d94-1348-15fd-b48f-a80e8885c7a4@gmail.com
Signed-off-by: Dmitry Torokhov <dmitry.torokhov@gmail.com >
2023-05-22 17:28:16 -07:00
SeongJae Park
941c95fdd6
Docs/subsystem-apis: Remove '[The ]Linux' prefixes from titles of listed documents
...
Some documents that listed on subsystem-apis have 'Linux' or 'The Linux'
title prefixes. It's duplicated information, and makes finding the
document of interest with human eyes not easy. Remove the prefixes from
the titles.
Signed-off-by: SeongJae Park <sj@kernel.org >
Acked-by: Iwona Winiarska <iwona.winiarska@intel.com >
Acked-by: Bjorn Helgaas <bhelgaas@google.com >
Link: https://lore.kernel.org/r/20230122184834.181977-1-sj@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2023-01-24 15:27:08 -07:00
Dmitry Torokhov
5f8f8574c7
Merge branch 'next' into for-linus
...
Prepare input updates for 6.1 merge window.
2022-10-09 22:30:23 -07:00
Nate Yocom
1260cd04a6
Input: add ABS_PROFILE to uapi and documentation
...
Define new ABS_PROFILE axis for input devices which need it, e.g. X-Box
Adaptive Controller and X-Box Elite 2.
Signed-off-by: Nate Yocom <nate@yocom.org >
Link: https://lore.kernel.org/r/20220908173930.28940-4-nate@yocom.org
Signed-off-by: Dmitry Torokhov <dmitry.torokhov@gmail.com >
2022-09-28 18:31:37 -07:00
Greg Tulli
9c9c71168f
Input: iforce - add support for Boeder Force Feedback Wheel
...
Add a new iforce_device entry to support the Boeder Force Feedback Wheel
device.
Signed-off-by: Greg Tulli <greg.iforce@gmail.com >
Link: https://lore.kernel.org/r/3256420-c8ac-31b-8499-3c488a9880fd@gmail.com
Signed-off-by: Dmitry Torokhov <dmitry.torokhov@gmail.com >
2022-08-29 11:45:28 -07:00
Nelson Penn
a27e51b45e
documentation: Format button_dev as a pointer.
...
The docs on creating an input device driver have an example in which
button_dev is a pointer to an input_dev struct. However, in two code
snippets below, button_dev is used as if it is not a pointer. Make these
occurrences of button_dev reflect that it is a pointer.
Signed-off-by: Nelson Penn <nelsonapenn@protonmail.com >
Link: https://lore.kernel.org/r/20220522194953.12097-1-nelsonapenn@protonmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2022-06-01 09:34:28 -06:00
Randy Dunlap
206bc43486
input: Docs: correct ntrig.rst typo
...
Fix a typo in ntrig.rst (found with 'codespell').
Signed-off-by: Randy Dunlap <rdunlap@infradead.org >
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com >
Cc: linux-input@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net >
Link: https://lore.kernel.org/r/20220516002047.11395-1-rdunlap@infradead.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2022-05-17 13:29:40 -06:00
Randy Dunlap
27ff683948
input: Docs: correct atarikbd.rst typos
...
Fix 2 "MOSE" typos in atarikbd.rst (found with 'codespell').
a. s/MOSE/MODE/
b. s/MOSE/MOUSE/
Signed-off-by: Randy Dunlap <rdunlap@infradead.org >
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com >
Cc: linux-input@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net >
Link: https://lore.kernel.org/r/20220516002055.12000-1-rdunlap@infradead.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2022-05-17 13:29:10 -06:00
Benjamin Tissoires
42764f97e6
Input: docs: add more details on the use of BTN_TOOL
...
The HID core stack used to be very relaxed considering the BTN_TOOL_*
usage. With the recent commits, we should now enforce to have only one
tool at a time, meaning that we can now express that requirement in the
docs.
Signed-off-by: Benjamin Tissoires <benjamin.tissoires@redhat.com >
Reviewed-by: Ping Cheng <ping.cheng@wacom.com >
Acked-by: Peter Hutterer <peter.hutterer@who-t.net >
Signed-off-by: Jiri Kosina <jkosina@suse.cz >
2022-03-01 15:46:03 +01:00
Kees Cook
f9ce26c56d
docs: networking: Replace strncpy() with strscpy()
...
Replace example code's use of strncpy() with strscpy() functions. Using
strncpy() is considered deprecated:
https://www.kernel.org/doc/html/latest/process/deprecated.html#strncpy-on-nul-terminated-strings
Signed-off-by: Kees Cook <keescook@chromium.org >
Acked-by: Dmitry Torokhov <dmitry.torokhov@gmail.com >
Link: https://lore.kernel.org/r/20210602202914.4079123-1-keescook@chromium.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2021-06-04 11:21:43 -06:00
Linus Torvalds
aef511fb91
Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input
...
Pull input updates from Dmitry Torokhov:
- three new touchscreen drivers: Hycon HY46XX, ILITEK Lego Series,
and MStar MSG2638
- a new driver for Azoteq IQS626A proximity and touch controller
- addition of Amazon Game Controller to the list of devices handled
by the xpad driver
- Elan touchscreen driver will avoid binding to devices described as
I2CHID compatible in ACPI tables
- various driver fixes
* 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input: (56 commits)
Input: xpad - add support for Amazon Game Controller
Input: ili210x - add missing negation for touch indication on ili210x
MAINTAINERS: repair reference in HYCON HY46XX TOUCHSCREEN SUPPORT
Input: add driver for the Hycon HY46XX touchpanel series
dt-bindings: touchscreen: Add HY46XX bindings
dt-bindings: Add Hycon Technology vendor prefix
Input: cyttsp - flag the device properly
Input: cyttsp - set abs params for ABS_MT_TOUCH_MAJOR
Input: cyttsp - drop the phys path
Input: cyttsp - reduce reset pulse timings
Input: cyttsp - error message on boot mode exit error
Input: apbps2 - remove useless variable
Input: mms114 - support MMS136
Input: mms114 - convert bindings to YAML and extend
Input: Add support for ILITEK Lego Series
dt-bindings: input: touchscreen: ilitek_ts_i2c: Add bindings
Input: add MStar MSG2638 touchscreen driver
dt-bindings: input/touchscreen: add bindings for msg2638
Input: silead - add workaround for x86 BIOS-es which bring the chip up in a stuck state
Input: elants_i2c - do not bind to i2c-hid compatible ACPI instantiated devices
...
2021-05-06 23:37:55 -07:00
Randy Dunlap
eef8abdaed
Documentation: input: joydev file corrections
...
Fix typos, grammar, punctuation in
Documentation/input/joydev/*.rst files.
Signed-off-by: Randy Dunlap <rdunlap@infradead.org >
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com >
Link: https://lore.kernel.org/r/20210429063137.20232-1-rdunlap@infradead.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2021-05-03 16:51:10 -06:00
Dmitry Torokhov
5acac83bf2
Merge tag 'v5.12-rc4' into next
...
Sync up with the mainline to bring in newest APIs.
2021-03-25 11:46:10 -07:00
Heikki Krogerus
6484e75817
Input: rotary-encoder - update docs according to the latest API changes
...
The old device property API is about to be removed, so
explaing how to use complete software nodes instead.
Signed-off-by: Heikki Krogerus <heikki.krogerus@linux.intel.com >
Link: https://lore.kernel.org/r/20210304090948.27014-1-heikki.krogerus@linux.intel.com
Signed-off-by: Dmitry Torokhov <dmitry.torokhov@gmail.com >
2021-03-25 11:14:08 -07:00
Randy Dunlap
8bd490e4fc
input: Documentation: corrections for uinput.rst
...
Fix a typo (supportinf -> supporting).
Signed-off-by: Randy Dunlap <rdunlap@infradead.org >
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com >
Cc: linux-input@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net >
Cc: linux-doc@vger.kernel.org
Link: https://lore.kernel.org/r/20210302223523.20130-9-rdunlap@infradead.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2021-03-08 17:15:37 -07:00
Randy Dunlap
5c1841152b
input: Documentation: corrections for input-programming.rst
...
Drop a repeated word.
Fix punctuation of "eg." to "e.g."
Fix punctuation of "ie" to "i.e."
Add hyphentation to non-zero.
Capitalize PM (for Power Management).
Capitalize ID (for Identifier).
Change "," in a run-on sentence to ";".
Signed-off-by: Randy Dunlap <rdunlap@infradead.org >
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com >
Cc: linux-input@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net >
Cc: linux-doc@vger.kernel.org
Link: https://lore.kernel.org/r/20210302223523.20130-8-rdunlap@infradead.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2021-03-08 17:15:36 -07:00
Randy Dunlap
365c6a3e0f
input: Documentation: corrections for notifier.rst
...
Add 'ledstate' to the keyboard_notifier_param struct info and tell
which header file contains that struct.
Signed-off-by: Randy Dunlap <rdunlap@infradead.org >
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com >
Cc: linux-input@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net >
Cc: linux-doc@vger.kernel.org
Link: https://lore.kernel.org/r/20210302223523.20130-7-rdunlap@infradead.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2021-03-08 17:15:36 -07:00
Randy Dunlap
338b660bff
input: Documentation: corrections for multi-touch-protocol.rst
...
Correct hyphenation, spelling, and capitalization.
Signed-off-by: Randy Dunlap <rdunlap@infradead.org >
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com >
Cc: linux-input@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net >
Cc: linux-doc@vger.kernel.org
Cc: Henrik Rydberg <rydberg@bitmath.org >
Link: https://lore.kernel.org/r/20210302223523.20130-6-rdunlap@infradead.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2021-03-08 17:15:36 -07:00
Randy Dunlap
ebe14885ab
input: Documentation: corrections for gameport-programming.rst
...
Use "E.g." instead of "Eg.".
Use correct index for buttons[] array.
Update all of struct gameport's descriptions.
Signed-off-by: Randy Dunlap <rdunlap@infradead.org >
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com >
Cc: linux-input@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net >
Cc: linux-doc@vger.kernel.org
Link: https://lore.kernel.org/r/20210302223523.20130-5-rdunlap@infradead.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2021-03-08 17:15:36 -07:00
Randy Dunlap
a9600c9858
input: Documentation: update related file names in ff.rst
...
Change other related documentation file names from .txt to .rst
and be more explicit about their paths/locations.
Signed-off-by: Randy Dunlap <rdunlap@infradead.org >
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com >
Cc: linux-input@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net >
Cc: linux-doc@vger.kernel.org
Cc: Johann Deneux <johann.deneux@gmail.com >
Cc: Anssi Hannula <anssi.hannula@gmail.com >
Link: https://lore.kernel.org/r/20210302223523.20130-4-rdunlap@infradead.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2021-03-08 17:15:36 -07:00
Randy Dunlap
61be51c1a6
input: Documentation: corrections for event-codes.rst
...
Fix hyphenation, typos, capitalization, and a referenced file name
(.txt -> .rst).
Signed-off-by: Randy Dunlap <rdunlap@infradead.org >
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com >
Cc: linux-input@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net >
Cc: linux-doc@vger.kernel.org
Link: https://lore.kernel.org/r/20210302223523.20130-3-rdunlap@infradead.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2021-03-08 17:15:36 -07:00
Randy Dunlap
d1c34bb205
input: Documentation: corrections for input.rst
...
Fix grammar, punctuation, and spelling.
Signed-off-by: Randy Dunlap <rdunlap@infradead.org >
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com >
Cc: linux-input@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net >
Cc: linux-doc@vger.kernel.org
Link: https://lore.kernel.org/r/20210302223523.20130-2-rdunlap@infradead.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2021-03-08 17:15:36 -07:00