]> git.ipfire.org Git - thirdparty/kernel/linux.git/commit - scripts/kernel-doc
scripts: kernel-doc: try to use c:function if possible
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Wed, 30 Sep 2020 07:47:01 +0000 (09:47 +0200)
committerMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Thu, 15 Oct 2020 05:49:37 +0000 (07:49 +0200)
commit6e9e415854c15dbf920481eb1d245988e405bbc0
tree67ca21cd669c9753bc5ac73aafe5bbcd2a6e1196
parent5ef09c96d48b41a55121df1b57404f68d7e4e5f1
scripts: kernel-doc: try to use c:function if possible

There are a few namespace clashes by using c:macro everywhere:

basically, when using it, we can't have something like:

.. c:struct:: pwm_capture

.. c:macro:: pwm_capture

So, we need to use, instead:

.. c:function:: int pwm_capture (struct pwm_device * pwm, struct pwm_capture * result, unsigned long timeout)

for the function declaration.

The kernel-doc change was proposed by Jakob Lykke Andersen here:

https://github.com/jakobandersen/linux_docs/commit/6fd2076ec001cca7466857493cd678df4dfe4a65

Although I did a different implementation.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
scripts/kernel-doc