Re: [PATCH] lib: rename TEST_MODULE to TEST_LKM

From: Valentin Rothberg
Date: Tue Sep 23 2014 - 14:27:13 EST


On mar., 2014-09-23 at 10:11 -0700, Randy Dunlap wrote:
> On 09/23/14 10:10, Valentin Rothberg wrote:
> > On mar., 2014-09-23 at 09:49 -0700, Randy Dunlap wrote:
> >> On 09/22/14 23:58, Valentin Rothberg wrote:
> >>> The "_MODULE" suffix is reserved for tristates compiled as
> >>> loadable kernel modules (LKM). The "TEST_MODULE" feature thereby
> >>
> >> Is that documented anywhere?
> >
> > Sadly this is not made explicit, but the Kconfig code documents it. The
> > following code (./scripts/kconfig/confdata.c) is used to generate the
> > autoconf.h header file during the build process. When a feature is
> > selected as a kernel module ('m'), it is suffixed with "_MODULE" to
> > indicate it.
> >
> > Â Â switch (*value) {
> > Â Â case 'n':
> > Â Â Â break;
> > Â Â case 'm':
> > Â Â Â suffix = "_MODULE";
> > Â Â Â /* fall through */
> >
> >> Was this causing some kind of problem or error? Please tell us what that was if so.
> >
> > It causes problems for static code analysis, which assumes a consistent
> > use of the "_MODULE" suffix.
> >
> > Another possible change would be to rename the reference in the Makefile
> > to "TEST_MODULE_MODULE". Personally, I prefer my proposed patch.
>
> Sure, your patch is fine, but we need to know *why* the patch is needed.

Thank you for pointing that out. I will take care to give more
information in future patches.

Thanks,
Valentin

> Thanks.
>
> >>
> >>
> >>> violates this convention. The feature is used to compile the
> >>> lib/test_module.c kernel module.
> >>>
> >>> This patch renames the feature and its reference in a Makefile
> >>> to "TEST_LKM", which still expresses the test of a LKM.
> >>>
> >>> Signed-off-by: Valentin Rothberg <valentinrothberg@xxxxxxxxx>
> >>> ---
> >>> lib/Kconfig.debug | 2 +-
> >>> lib/Makefile | 2 +-
> >>> 2 files changed, 2 insertions(+), 2 deletions(-)
> >>>
> >>> diff --git a/lib/Kconfig.debug b/lib/Kconfig.debug
> >>> index 07c2832..db91c97 100644
> >>> --- a/lib/Kconfig.debug
> >>> +++ b/lib/Kconfig.debug
> >>> @@ -1627,7 +1627,7 @@ config DMA_API_DEBUG
> >>>
> >>> If unsure, say N.
> >>>
> >>> -config TEST_MODULE
> >>> +config TEST_LKM
> >>> tristate "Test module loading with 'hello world' module"
> >>> default n
> >>> depends on m
> >>> diff --git a/lib/Makefile b/lib/Makefile
> >>> index d6b4bc4..382437a 100644
> >>> --- a/lib/Makefile
> >>> +++ b/lib/Makefile
> >>> @@ -31,7 +31,7 @@ obj-y += string_helpers.o
> >>> obj-$(CONFIG_TEST_STRING_HELPERS) += test-string_helpers.o
> >>> obj-y += kstrtox.o
> >>> obj-$(CONFIG_TEST_KSTRTOX) += test-kstrtox.o
> >>> -obj-$(CONFIG_TEST_MODULE) += test_module.o
> >>> +obj-$(CONFIG_TEST_LKM) += test_module.o
> >>> obj-$(CONFIG_TEST_USER_COPY) += test_user_copy.o
> >>> obj-$(CONFIG_TEST_BPF) += test_bpf.o
> >>> obj-$(CONFIG_TEST_FIRMWARE) += test_firmware.o
>
>


--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/