]> git.ipfire.org Git - thirdparty/kernel/linux.git/commit
docs: kdoc: some fixes to kernel-doc comments
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Mon, 19 Jan 2026 12:04:59 +0000 (13:04 +0100)
committerJonathan Corbet <corbet@lwn.net>
Tue, 20 Jan 2026 22:31:06 +0000 (15:31 -0700)
commit6cc45ee5df3bd89c8fa62aa2be91f747938686a1
tree270b86883cc04974d7c154fda456564e0adb4e8c
parentbd28e99720f3f070e80551b5e94695640d3a730a
docs: kdoc: some fixes to kernel-doc comments

There are some typos and English errors in the comments of kernel‑doc.py.

Locate them with the help of an LLM (gpt‑oss 14B), executed locally
with this prompt:

        review English grammar and syntax at the comments on the code below:
        <cat scripts/kernel-doc.py>

While LLM worked fine for the task of doing an English grammar review
for strings, being able to distinguish them from the actual code, it
was not is perfect: some things required manual work to fix.

-

While here, replace:

    "/**" with: ``/**``

As, if we ever rename this script to kernel_doc.py and add it to
Sphinx ext autodoc, we want to avoid this warning:

    scripts/kernel_doc.py:docstring of kernel_doc:10: WARNING: Inline strong start-string without end-string. [docutils]

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <ec08727f22ad35e6c58519c1f425f216f14b701c.1768823489.git.mchehab+huawei@kernel.org>
scripts/kernel-doc.py