]> git.ipfire.org Git - thirdparty/kernel/stable.git/commitdiff
docs: driver-api/infiniband.rst: fix Kerneldoc markup
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Mon, 24 Feb 2025 09:08:10 +0000 (10:08 +0100)
committerJonathan Corbet <corbet@lwn.net>
Tue, 4 Mar 2025 16:47:38 +0000 (09:47 -0700)
kerneldoc.py extension doesn't handle a "\" character at the end
of the line: it will just merge it to the cmd line, producing
this command:

scripts/kernel-doc -rst -enable-lineno -function iscsi_iser_pdu_alloc -function iser_initialize_task_headers -function \ -function iscsi_iser_task_init -function iscsi_iser_mtask_xmit -function iscsi_iser_task_xmit -function \ -function iscsi_iser_cleanup_task -function iscsi_iser_check_protection -function \ -function iscsi_iser_conn_create -function iscsi_iser_conn_bind -function \ -function iscsi_iser_conn_start -function iscsi_iser_conn_stop -function \ -function iscsi_iser_session_destroy -function iscsi_iser_session_create -function \ -function iscsi_iser_set_param -function iscsi_iser_ep_connect -function iscsi_iser_ep_poll -function \ -function iscsi_iser_ep_disconnect ./drivers/infiniband/ulp/iser/iscsi_iser.c

which may not work as expected.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/64e7949439c5fc39f2c9441027ad02bc60cbf0dd.1740387599.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/driver-api/infiniband.rst

index 30e142ccbee9114cd171c9a5312efbe667f5e1f2..10d8be9e74fe1d4946517033ffbb15813cbe0342 100644 (file)
@@ -77,14 +77,14 @@ iSCSI Extensions for RDMA (iSER)
    :internal:
 
 .. kernel-doc:: drivers/infiniband/ulp/iser/iscsi_iser.c
-   :functions: iscsi_iser_pdu_alloc iser_initialize_task_headers \
-       iscsi_iser_task_init iscsi_iser_mtask_xmit iscsi_iser_task_xmit \
-       iscsi_iser_cleanup_task iscsi_iser_check_protection \
-       iscsi_iser_conn_create iscsi_iser_conn_bind \
-       iscsi_iser_conn_start iscsi_iser_conn_stop \
-       iscsi_iser_session_destroy iscsi_iser_session_create \
-       iscsi_iser_set_param iscsi_iser_ep_connect iscsi_iser_ep_poll \
-       iscsi_iser_ep_disconnect
+   :functions: iscsi_iser_pdu_alloc iser_initialize_task_headers
+               iscsi_iser_task_init iscsi_iser_mtask_xmit iscsi_iser_task_xmit
+               iscsi_iser_cleanup_task iscsi_iser_check_protection
+               iscsi_iser_conn_create iscsi_iser_conn_bind
+               iscsi_iser_conn_start iscsi_iser_conn_stop
+               iscsi_iser_session_destroy iscsi_iser_session_create
+               iscsi_iser_set_param iscsi_iser_ep_connect iscsi_iser_ep_poll
+               iscsi_iser_ep_disconnect
 
 .. kernel-doc:: drivers/infiniband/ulp/iser/iser_initiator.c
    :internal: