]> www.infradead.org Git - users/jedix/linux-maple.git/commitdiff
HID: bpf: doc fixes for hid_hw_request() hooks
authorBenjamin Tissoires <bentiss@kernel.org>
Mon, 1 Jul 2024 12:39:51 +0000 (14:39 +0200)
committerBenjamin Tissoires <bentiss@kernel.org>
Mon, 1 Jul 2024 12:48:14 +0000 (14:48 +0200)
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@canb.auug.org.au>
Fixes: 8bd0488b5ea5 ("HID: bpf: add HID-BPF hooks for hid_hw_raw_requests")
Link: https://patch.msgid.link/20240701-fix-cki-v2-3-20564e2e1393@kernel.org
Signed-off-by: Benjamin Tissoires <bentiss@kernel.org>
include/linux/hid_bpf.h

index 3f6584014311a4a47c3998e718083fbcf5fb6ca8..c30c31b79419dbd6fd629ceb364b402525612797 100644 (file)
@@ -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