[PATCH v2 3/4] HID: bpf: doc fixes for hid_hw_request() hooks
From: Benjamin Tissoires
Date: Mon Jul 01 2024 - 08:41:02 EST
We had the following errors while doing make htmldocs:
Documentation/hid/hid-bpf:185: include/linux/hid_bpf.h:144:
ERROR: Unexpected indentation.
Documentation/hid/hid-bpf:185: include/linux/hid_bpf.h:145:
WARNING: Block quote ends without a blank line;
unexpected unindent.
Documentation/hid/hid-bpf:185: include/linux/hid_bpf.h:147:
ERROR: Unexpected indentation.
Reported-by: Stephen Rothwell <sfr@xxxxxxxxxxxxxxxx>
Fixes: 8bd0488b5ea5 ("HID: bpf: add HID-BPF hooks for hid_hw_raw_requests")
Signed-off-by: Benjamin Tissoires <bentiss@xxxxxxxxxx>
---
include/linux/hid_bpf.h | 11 +++++++----
1 file changed, 7 insertions(+), 4 deletions(-)
diff --git a/include/linux/hid_bpf.h b/include/linux/hid_bpf.h
index 3f6584014311..c30c31b79419 100644
--- a/include/linux/hid_bpf.h
+++ b/include/linux/hid_bpf.h
@@ -139,12 +139,15 @@ struct hid_bpf_ops {
*
* ``ctx``: The HID-BPF context as &struct hid_bpf_ctx
* ``reportnum``: the report number, as in hid_hw_raw_request()
+ *
* ``rtype``: the report type (``HID_INPUT_REPORT``, ``HID_FEATURE_REPORT``,
- * ``HID_OUTPUT_REPORT``)
+ * ``HID_OUTPUT_REPORT``)
+ *
* ``reqtype``: the request
+ *
* ``source``: a u64 referring to a uniq but identifiable source. If %0, the
- * kernel itself emitted that call. For hidraw, ``source`` is set
- * to the associated ``struct file *``.
+ * kernel itself emitted that call. For hidraw, ``source`` is set
+ * to the associated ``struct file *``.
*
* Return: %0 to keep processing the request by hid-core; any other value
* stops hid-core from processing that event. A positive value should be
@@ -153,7 +156,7 @@ struct hid_bpf_ops {
*/
int (*hid_hw_request)(struct hid_bpf_ctx *ctx, unsigned char reportnum,
enum hid_report_type rtype, enum hid_class_request reqtype,
- __u64 source);
+ u64 source);
/**
* @hid_hw_output_report: called whenever a hid_hw_output_report() call is emitted
--
2.44.0