Date: Wed, 15 Apr 2009 21:42:26 +0200
From: Sam Ravnborg <sam@ravnborg.org>
To: devzero@web.de
Cc: linux-kernel@vger.kernel.org, alan@lxorguk.ukuu.org.uk
Subject: Re: Should MODULE_DESCRIPTION be mandatory ?
Message-ID: <20090415194226.GB25783@uranus.ravnborg.org>
References: <671646821@web.de>
Mime-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: 8bit
In-Reply-To: <671646821@web.de>
User-Agent: Mutt/1.4.2.1i
Sender: linux-kernel-owner@vger.kernel.org
Content-Length: 1870
Lines: 45

On Wed, Apr 15, 2009 at 01:11:46PM +0200, devzero@web.de wrote:
> Hi, 
> 
> some time ago i spotted that around 20% of the Linux modules lacking a MODULE_DESCRIPTION field.  ( http://bugzilla.kernel.org/show_bug.cgi?id=10770 )
> 
> I think it`s not a practicable approach to get this fixed by some single person digging trough all the modules. 
> If itŽs fixed for a kernel release, one year later there would be another bunch of new modules lacking the description field again.
> 
> What about a build-time or run-time warning for missing MODULE_DESCRIPTION ? (as it exists for MODULE_LICENSE in modpost.c) 


You mean something like the following untested patch?
If it works what is the output for an allmodconfig build?

	Sam

diff --git a/scripts/mod/modpost.c b/scripts/mod/modpost.c
index 8cc7061..5317d6f 100644
--- a/scripts/mod/modpost.c
+++ b/scripts/mod/modpost.c
@@ -1553,6 +1553,7 @@ static void read_symbols(char *modname)
 	const char *symname;
 	char *version;
 	char *license;
+	char *description;
 	struct module *mod;
 	struct elf_info info = { };
 	Elf_Sym *sym;
@@ -1584,6 +1585,11 @@ static void read_symbols(char *modname)
 		license = get_next_modinfo(info.modinfo, info.modinfo_len,
 					   "license", license);
 	}
+	description = get_modinfo(info.modinfo, info.modinfo_len, "description");
+	if (info.modinfo && !description && !is_vmlinux(modname))
+		warn("modpost: missing MODULE_DESCRIPTION() in %s\n"
+		     "see include/linux/module.h for "
+		     "more information\n", modname);
 
 	for (sym = info.symtab_start; sym < info.symtab_stop; sym++) {
 		symname = info.strtab + sym->st_name;
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/