* [PATCH 0/2] hid-alps docs heading cleanup
@ 2025-10-24 10:39 Bagas Sanjaya
2025-10-24 10:39 ` [PATCH 1/2] Documentation: hid-alps: Fix packet format section headings Bagas Sanjaya
` (2 more replies)
0 siblings, 3 replies; 4+ messages in thread
From: Bagas Sanjaya @ 2025-10-24 10:39 UTC (permalink / raw)
To: Linux Kernel Mailing List, Linux Documentation,
Linux Input Devices
Cc: Jiri Kosina, Benjamin Tissoires, Jonathan Corbet, Masaki Ota,
George Anthony Vernon, Bagas Sanjaya
Hi,
Here are two section headings cleanup patches for Alps HID documentation.
Enjoy!
Bagas Sanjaya (2):
Documentation: hid-alps: Fix packet format section headings
Documentation: hid-alps: Format DataByte* subsection headings
Documentation/hid/hid-alps.rst | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
base-commit: 828aeac92901c1f31b51ae0b9d792b9af5bd3e27
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply [flat|nested] 4+ messages in thread* [PATCH 1/2] Documentation: hid-alps: Fix packet format section headings
2025-10-24 10:39 [PATCH 0/2] hid-alps docs heading cleanup Bagas Sanjaya
@ 2025-10-24 10:39 ` Bagas Sanjaya
2025-10-24 10:39 ` [PATCH 2/2] Documentation: hid-alps: Format DataByte* subsection headings Bagas Sanjaya
2025-10-25 7:12 ` [PATCH 0/2] hid-alps docs heading cleanup Randy Dunlap
2 siblings, 0 replies; 4+ messages in thread
From: Bagas Sanjaya @ 2025-10-24 10:39 UTC (permalink / raw)
To: Linux Kernel Mailing List, Linux Documentation,
Linux Input Devices
Cc: Jiri Kosina, Benjamin Tissoires, Jonathan Corbet, Masaki Ota,
George Anthony Vernon, Bagas Sanjaya
In "Packet Format" section, only "StickPointer data byte" subsection
heading is shown as such in htmldocs output; "Touchpad data byte" one
is in normal paragraph on the other hand.
Properly format the headings to be consistent.
Fixes: 2562756dde55 ("HID: add Alps I2C HID Touchpad-Stick support")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Documentation/hid/hid-alps.rst | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/Documentation/hid/hid-alps.rst b/Documentation/hid/hid-alps.rst
index 94382bb0ada4d8..3a22254e43464f 100644
--- a/Documentation/hid/hid-alps.rst
+++ b/Documentation/hid/hid-alps.rst
@@ -104,8 +104,10 @@ Read value is stored in Value Byte.
Packet Format
+-------------
+
Touchpad data byte
-------------------
+~~~~~~~~~~~~~~~~~~
======= ======= ======= ======= ======= ======= ======= ======= =====
@@ -156,7 +158,7 @@ Zsn_6-0(7bit):
StickPointer data byte
-----------------------
+~~~~~~~~~~~~~~~~~~~~~~
======= ======= ======= ======= ======= ======= ======= ======= =====
- b7 b6 b5 b4 b3 b2 b1 b0
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply related [flat|nested] 4+ messages in thread* [PATCH 2/2] Documentation: hid-alps: Format DataByte* subsection headings
2025-10-24 10:39 [PATCH 0/2] hid-alps docs heading cleanup Bagas Sanjaya
2025-10-24 10:39 ` [PATCH 1/2] Documentation: hid-alps: Fix packet format section headings Bagas Sanjaya
@ 2025-10-24 10:39 ` Bagas Sanjaya
2025-10-25 7:12 ` [PATCH 0/2] hid-alps docs heading cleanup Randy Dunlap
2 siblings, 0 replies; 4+ messages in thread
From: Bagas Sanjaya @ 2025-10-24 10:39 UTC (permalink / raw)
To: Linux Kernel Mailing List, Linux Documentation,
Linux Input Devices
Cc: Jiri Kosina, Benjamin Tissoires, Jonathan Corbet, Masaki Ota,
George Anthony Vernon, Bagas Sanjaya
"Command Read/Write" section has two DataByte* subsections describing
command bytes format. Add markup to these subsection heading texts.
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Documentation/hid/hid-alps.rst | 2 ++
1 file changed, 2 insertions(+)
diff --git a/Documentation/hid/hid-alps.rst b/Documentation/hid/hid-alps.rst
index 3a22254e43464f..4a22a357f00c02 100644
--- a/Documentation/hid/hid-alps.rst
+++ b/Documentation/hid/hid-alps.rst
@@ -69,6 +69,7 @@ To read/write to RAM, need to send a command to the device.
The command format is as below.
DataByte(SET_REPORT)
+~~~~~~~~~~~~~~~~~~~~
===== ======================
Byte1 Command Byte
@@ -89,6 +90,7 @@ Value Byte is writing data when you send the write commands.
When you read RAM, there is no meaning.
DataByte(GET_REPORT)
+~~~~~~~~~~~~~~~~~~~~
===== ======================
Byte1 Response Byte
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH 0/2] hid-alps docs heading cleanup
2025-10-24 10:39 [PATCH 0/2] hid-alps docs heading cleanup Bagas Sanjaya
2025-10-24 10:39 ` [PATCH 1/2] Documentation: hid-alps: Fix packet format section headings Bagas Sanjaya
2025-10-24 10:39 ` [PATCH 2/2] Documentation: hid-alps: Format DataByte* subsection headings Bagas Sanjaya
@ 2025-10-25 7:12 ` Randy Dunlap
2 siblings, 0 replies; 4+ messages in thread
From: Randy Dunlap @ 2025-10-25 7:12 UTC (permalink / raw)
To: Bagas Sanjaya, Linux Kernel Mailing List, Linux Documentation,
Linux Input Devices
Cc: Jiri Kosina, Benjamin Tissoires, Jonathan Corbet, Masaki Ota,
George Anthony Vernon
On 10/24/25 3:39 AM, Bagas Sanjaya wrote:
> Hi,
>
> Here are two section headings cleanup patches for Alps HID documentation.
> Enjoy!
>
> Bagas Sanjaya (2):
> Documentation: hid-alps: Fix packet format section headings
> Documentation: hid-alps: Format DataByte* subsection headings
>
> Documentation/hid/hid-alps.rst | 8 ++++++--
> 1 file changed, 6 insertions(+), 2 deletions(-)
Much nicer. Thanks.
for both patches:
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
--
~Randy
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2025-10-25 7:12 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-10-24 10:39 [PATCH 0/2] hid-alps docs heading cleanup Bagas Sanjaya
2025-10-24 10:39 ` [PATCH 1/2] Documentation: hid-alps: Fix packet format section headings Bagas Sanjaya
2025-10-24 10:39 ` [PATCH 2/2] Documentation: hid-alps: Format DataByte* subsection headings Bagas Sanjaya
2025-10-25 7:12 ` [PATCH 0/2] hid-alps docs heading cleanup Randy Dunlap
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).