kconfig.h: explain IS_MODULE(), IS_ENABLED()
authorBjorn Helgaas <bhelgaas@google.com>
Tue, 1 Jun 2021 21:31:43 +0000 (16:31 -0500)
committerMasahiro Yamada <masahiroy@kernel.org>
Sat, 5 Jun 2021 14:49:46 +0000 (23:49 +0900)
commitc7c90e121e992eefdf07945e5a6e9cf097b29463
treeecf6d93c6f42294695b874c2d78e3d058dc52380
parent43ac711053fc6d94a3f16141c4efe20059a9d918
kconfig.h: explain IS_MODULE(), IS_ENABLED()

Extend IS_MODULE() and IS_ENABLED comments to explain why one might use
"#if IS_ENABLED(CONFIG_FOO)" instead of "#ifdef CONFIG_FOO".

To wit, "#ifdef CONFIG_FOO" is true only for CONFIG_FOO=y, while
"#if IS_ENABLED(CONFIG_FOO)" is true for both CONFIG_FOO=y and
CONFIG_FOO=m.

This is because "CONFIG_FOO=m" in .config does not result in "CONFIG_FOO"
being defined.  The actual definitions are in autoconf.h, where:

  CONFIG_FOO=y   results in   #define CONFIG_FOO 1
  CONFIG_FOO=m   results in   #define CONFIG_FOO_MODULE 1

Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Masahiro Yamada <masahiroy@kernel.org>
include/linux/kconfig.h