docs: sphinx: kerneldoc: ignore "\" characters from options
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Tue, 8 Apr 2025 10:09:23 +0000 (18:09 +0800)
committerJonathan Corbet <corbet@lwn.net>
Wed, 9 Apr 2025 18:10:33 +0000 (12:10 -0600)
commit01c43355255e1f0bba8677fc66facc0047a23242
tree14e6e9ee5f7f8042301f78f9cd51519c10001466
parent668b9d1dceb86b570ff28d913e8464ba62f57e91
docs: sphinx: kerneldoc: ignore "\" characters from options

Documentation/driver-api/infiniband.rst has a kernel-doc tag
with "\" characters at the end:

.. 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

This is not handled well, as the "\" strings will be just stored inside
Sphinx options.

While the actual problem deserves being fixed, better to relax the
keneldoc.py extension to silently strip "\" from the end of strings,
as otherwise this may cause troubles when preparing arguments to
be executed by kernel-doc.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/4c652d6c57b20500c135b95294e554d9e9a97f42.1744106242.git.mchehab+huawei@kernel.org
Documentation/sphinx/kerneldoc.py