From: Akira Yokosawa <akiyks@gmail.com>
To: Jonathan Corbet <corbet@lwn.net>,
Greg KH <gregkh@linuxfoundation.org>,
Peter Zijlstra <peterz@infradead.org>,
Masahiro Yamada <masahiroy@kernel.org>
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
Linus Torvalds <torvalds@linux-foundation.org>,
Akira Yokosawa <akiyks@gmail.com>
Subject: Re: [PATCH] scripts/kernel-doc: Get -export option working again
Date: Thu, 12 Dec 2024 00:23:35 +0900 [thread overview]
Message-ID: <ac6bb4a4-d57c-481d-93e1-e08ab9fd6bdc@gmail.com> (raw)
In-Reply-To: <87v7vr12qr.fsf@trenco.lwn.net>
Jonathan Corbet wrote:
> Akira Yokosawa <akiyks@gmail.com> writes:
>
>> Jonathan Corbet wrote:
>> [...]
>>> Ah ... I should have thought of that ... I'm glad you did. I've just
>>> pushed the fix out to linux-next, will send it Linusward in the near
>>> future. Thanks for fixing this,
>>
>> Your docs-fixes is based on v6.13-rc1.
>> This fix needs to come after v6.13-rc2.
>
> ...which will happen once the fix hits mainline - the *fix* doesn't
> depend on -rc2.
>
Well...
The fix conflicts semantically against v6.13-rc1.
I know you hate full rebuild of htmldocs. But I'd like you to follow
the following steps to see the full scope of this fix.
- git checkout v6.13-rc2
- git checkout docs-fixes
- make htmldocs
You might be surprised, but you'll see the following:
./drivers/dma-buf/dma-buf.c:1: warning: no structured comments found
./drivers/iommu/iommufd/device.c:1: warning: no structured comments found
./drivers/iommu/iommufd/main.c:1: warning: no structured comments found
./drivers/counter/counter-core.c:1: warning: no structured comments found
./drivers/counter/counter-chrdev.c:1: warning: no structured comments found
Current docs-fixes has a semantic conflicts opposite to the one v6.13-rc2 has.
I'd really like you to send a pull request that resolves the semantic
conflict existing in v6.13-rc2, not the one that happens to negate the
conflict on merge.
That's the minimal expectation I have.
You might wonder whey you need to checkout v6.13-rc2 first and go back
to docs-fixes to see the conflict there.
That's because "make htmldocs" don't rerun kernel-doc conversion
when only the kernel-doc script is updated. To see the effect of
its change, source files with affected kernel-doc comments and
"EXPORT_SYMBOL*" need to be updated as well.
Of course you are well aware of this problematic behavior of
documentation build.
I don't mind docs-mw if you'd like to keep it v6.13-rc1 based.
Have I made my points clear enough for you?
Thanks, Akira
next prev parent reply other threads:[~2024-12-11 15:23 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-12-10 11:04 [PATCH] scripts/kernel-doc: Get -export option working again Akira Yokosawa
2024-12-10 18:12 ` Randy Dunlap
2024-12-10 18:53 ` Matthew Wilcox
2024-12-10 20:58 ` Jonathan Corbet
2024-12-11 0:15 ` Akira Yokosawa
2024-12-11 0:29 ` Jonathan Corbet
2024-12-11 15:23 ` Akira Yokosawa [this message]
2024-12-11 16:25 ` Jonathan Corbet
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=ac6bb4a4-d57c-481d-93e1-e08ab9fd6bdc@gmail.com \
--to=akiyks@gmail.com \
--cc=corbet@lwn.net \
--cc=gregkh@linuxfoundation.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=masahiroy@kernel.org \
--cc=peterz@infradead.org \
--cc=torvalds@linux-foundation.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.