Re: [PATCH hid v11 14/14] Documentation: add HID-BPF docs
From: Jonathan Corbet <corbet@lwn.net>
Date: 2022-10-26 13:44:52
Also in:
bpf, linux-doc, linux-kselftest, lkml
Bagas Sanjaya [off-list ref] writes:
The wordings are somewhat confusing, so here's the alternative:
I've been kind of ignoring these editorial comments of yours, but this bit of bikeshedding kind of exceeded my threshold.
quoted hunk ↗ jump to hunk
diff --git a/Documentation/hid/hid-bpf.rst b/Documentation/hid/hid-bpf.rst index ba35aa2e2ba836..c59bce4b9cf214 100644 --- a/Documentation/hid/hid-bpf.rst +++ b/Documentation/hid/hid-bpf.rst@@ -27,88 +27,89 @@ Assuming you have a joystick that is getting older, it is common to see it wobbling around its neutral point. This is usually filtered at the application level by adding a *dead zone* for this specific axis. -With HID-BPF, we can apply this filtering in the kernel directly so userspace -does not get woken up when nothing else is happening on the input controller. +With HID-BPF, the filter can be applied in the kernel directly so that +userspace does not get woken up when nothing else is happening on the input +controller.
How does a shift to the passive voice help here? What is the problem you are trying to solve?
-Of course, given that this dead zone is specific to an individual device, we -can not create a generic fix for all of the same joysticks. Adding a custom -kernel API for this (e.g. by adding a sysfs entry) does not guarantee this new -kernel API will be broadly adopted and maintained. +Of course, given that dead zone filter is device-specific, it is not possible
^
Missing article -------+
+to create a generic fix for all of the same joysticks. Adding a custom +kernel API for this (e.g. by adding a sysfs entry) does not guarantee that +the API will be broadly adopted and maintained. -HID-BPF allows the userspace program to load the program itself, ensuring we -only load the custom API when we have a user. +HID-BPF allows the userspace program to load the program itself, ensuring that +custom API is only needed for edge cases (like esoteric joysticks)
That (beyond the missing article) changes the meaning of the sentence; it no longer really makes sense. I'll stop here. Bagas, I've asked this several times: *please* stop trying to tell other contributors what to do and, instead, focus on contributing something useful yourself. You seem to have the energy and interest to do worthwhile stuff - please do that! Thanks, jon