mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
To: Masahiro Yamada <masahiroy@kernel.org>
Cc: Nathan Chancellor <nathan@kernel.org>,
	Nicolas Schier <nicolas@fjasle.eu>,
	Jonathan Corbet <corbet@lwn.net>,
	linux-kbuild@vger.kernel.org, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org, Arnd Bergmann <arnd@arndb.de>
Subject: Re: [PATCH] docs: kconfig: Mention IS_REACHABLE as way for optional dependency
Date: Sat, 15 Feb 2025 14:06:01 +0100	[thread overview]
Message-ID: <a09b2636-dc15-4970-81dd-a16b5a166464@linaro.org> (raw)
In-Reply-To: <886cb4b9-9d95-4346-9c38-923cb7c69036@linaro.org>

On 15/02/2025 14:01, Krzysztof Kozlowski wrote:
>> One more thing, please document the drawback of IS_REACHABLE.
> 
> Ack
> 
>>
>> It is true that IS_REACHABLE() resolves the link error, but we
>> will end up with run-time debugging.
>>
>> foo_init()
>> {
>>         if (IS_REACHABLE(CONFIG_BAZ))
>>                 baz_register(&foo);
>>         ...
>> }
>>
>> Even if CONFIG_BAZ is enabled, baz_register() may get discarded.
> 
> Hm, why would that happen? For compiler this would be "if(true)", so
> what case would lead to discarding?
> 
>> Users may scratch their head why baz_register() does not work.
>> Due to this reason, IS_REACHABLE() tends to be avoided.
> 
> I would rather say IS_REACHABLE should be avoided if someone really
> wants to document the dependency, not optional feature.
I hope I got your intention right below:



@@ -580,15 +570,31 @@ Some drivers are able to optionally use a feature from another module
-The most common way to express this optional dependency in Kconfig logic
-uses the slightly counterintuitive::
+There are two ways to express this optional dependency:
 
-  config FOO
+1. If pre-processor can discard entire optional code or module BAR does not
+   provide !BAR stubs then call can be guarded with IS_REACHABLE()::
+
+       foo_init()
+       {
+               if (IS_REACHABLE(CONFIG_BAR))
+                       bar_register(&foo);
+               ...
+       }
+
+   Drawback: this might lead to run-time debugging, when looking why
+   bar_register() was not called.
+
+2. Otherwise (and module BAR must provide all !BAR stubs) use the slightly
+   counterintuitive Kconfig syntax::
+
+     config FOO
        tristate "Support for foo hardware"
        depends on BAR || !BAR
 
 This means that there is either a dependency on BAR that disallows
-the combination of FOO=y with BAR=m, or BAR is completely disabled.
+the combination of FOO=y with BAR=m, or BAR is completely disabled.  Unlike
+IS_REACHABLE(), this option favors configuration-time debugging.
 For a more formalized approach if there are multiple drivers that have
 the same dependency, a helper symbol can be used, like::




Best regards,
Krzysztof

  reply	other threads:[~2025-02-15 13:06 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-02-15 11:42 Krzysztof Kozlowski
2025-02-15 12:44 ` Krzysztof Kozlowski
2025-02-15 12:54 ` Masahiro Yamada
2025-02-15 13:01   ` Krzysztof Kozlowski
2025-02-15 13:06     ` Krzysztof Kozlowski [this message]
2025-02-15 14:19     ` Masahiro Yamada

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=a09b2636-dc15-4970-81dd-a16b5a166464@linaro.org \
    --to=krzysztof.kozlowski@linaro.org \
    --cc=arnd@arndb.de \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kbuild@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=masahiroy@kernel.org \
    --cc=nathan@kernel.org \
    --cc=nicolas@fjasle.eu \
    /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®