From: Nathan Chancellor <nathan@kernel.org>
To: Nicolas Schier <n.schier@fritz.com>
Cc: Erkan Erdem <hexvalid@gmail.com>,
Julian Braha <julianbraha@gmail.com>,
linux-kbuild@vger.kernel.org, linux-kernel@vger.kernel.org,
Jonathan Corbet <corbet@lwn.net>,
Shuah Khan <skhan@linuxfoundation.org>,
Randy Dunlap <rdunlap@infradead.org>,
linux-doc@vger.kernel.org,
Nick Desaulniers <ndesaulniers@google.com>,
Bill Wendling <morbo@google.com>,
Justin Stitt <justinstitt@google.com>,
Kees Cook <kees@kernel.org>,
Masahiro Yamada <masahiroy@kernel.org>,
llvm@lists.linux.dev
Subject: Re: [PATCH v2] docs: kconfig: fix shell function syntax in caveats
Date: Tue, 15 Sep 2026 15:02:04 -0700 [thread overview]
Message-ID: <20260915220204.GA1534234@ax162> (raw)
In-Reply-To: <20260915-pastel-industrious-rhino-8bddce@l-nschier-aarch64>
On Tue, Sep 15, 2026 at 12:59:40PM +0200, Nicolas Schier wrote:
> On Mon, Sep 07, 2026 at 01:37:37PM +0300, Erkan Erdem wrote:
> > Kconfig separates a function name from its arguments with a comma, but
> > the caveats section uses Make-style whitespace in its shell calls.
> > These expressions expand as undefined variables rather than invoking
> > the shell function, so the supposedly working CC_HAS_ENDIAN_FLAG
> > example fails to parse.
> >
> > Add the missing commas to the shell calls in this section. Keep the
> > Make examples unchanged.
> >
> > Fixes: 316d55d55f49 ("Documentation: kconfig: document a new Kconfig macro language")
> > Assisted-by: LLM
> > Signed-off-by: Erkan Erdem <hexvalid@gmail.com>
> > ---
> >
> > Changes in v2, addressing Julian Braha's review:
> > - Remove whitespace after the comma in the three remaining shell calls.
> >
> > v1: https://lore.kernel.org/all/20260905124045.42713-1-hexvalid@gmail.com/
> >
> > The issue, patch and changelog were prepared with an AI coding assistant.
> > The assistant also prepared the v2 revision and ran the checks below.
> >
> > Validation:
> > - Re-ran the documented working CC_HAS_ENDIAN_FLAG example using the
> > Kconfig conf tool built with Clang on macOS. With a test helper returning
> > y for either endian flag, the original example fails to parse; v2
> > executes both probes and sets CC_HAS_ENDIAN_FLAG=y for both endiannesses.
> > - Rebuilt the changed page alone with Sphinx, treating warnings as errors.
> > - The complete kernel documentation set and kernel were not built.
> >
> > Documentation/kbuild/kconfig-macro-language.rst | 8 ++++----
> > 1 file changed, 4 insertions(+), 4 deletions(-)
> >
>
> Thanks! I'll queue it for kbuild-fixes, but it might be defered to v7.4
> if no other build relevant fix will pop-up.
I am not opposed to this going via -fixes but given that it is just
documentation examples and there do not appear to be any problematic
instances in tree, I feel like this could very reasonably go through
-next. 316d55d55f49 is from 4.18, so the examples have been wrong for a
long time. With that, I would probably not classify it as urgent.
--
Cheers,
Nathan
prev parent reply other threads:[~2026-09-15 22:02 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-09-07 10:37 Erkan Erdem
2026-09-07 20:52 ` Julian Braha
2026-09-15 10:59 ` Nicolas Schier
2026-09-15 22:02 ` Nathan Chancellor [this message]
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=20260915220204.GA1534234@ax162 \
--to=nathan@kernel.org \
--cc=corbet@lwn.net \
--cc=hexvalid@gmail.com \
--cc=julianbraha@gmail.com \
--cc=justinstitt@google.com \
--cc=kees@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kbuild@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=llvm@lists.linux.dev \
--cc=masahiroy@kernel.org \
--cc=morbo@google.com \
--cc=n.schier@fritz.com \
--cc=ndesaulniers@google.com \
--cc=rdunlap@infradead.org \
--cc=skhan@linuxfoundation.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®