linux-kernel - Kconfig symbols: coding style: naming convention in Make and CPP syntax

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-ID: <CAD3Xx4LLYr-en1atZkj-qxQ=yDMi238eyryuZoxu2Spuxb8ACA@mail.gmail.com>
Date:	Mon, 6 Jul 2015 10:32:11 +0200
From:	Valentin Rothberg <valentinrothberg@...il.com>
To:	Linus Torvalds <torvalds@...ux-foundation.org>,
	Greg KH <gregkh@...uxfoundation.org>,
	Paul Bolle <pebolle@...cali.nl>,
	hengelein Stefan <stefan.hengelein@....de>,
	Andreas Ruprecht <andreas.ruprecht@....de>,
	linux-kbuild@...r.kernel.org, linux-kernel@...r.kernel.org,
	corbet@....net, akpm@...ux-foundation.org, sfr@...b.auug.org.au,
	apw@...onical.com, joe@...ches.com
Subject: Kconfig symbols: coding style: naming convention in Make and CPP syntax

Hi,

Kconfig symbols in Make and CPP syntax are prefixed with 'CONFIG_' and
suffixed with '_MODULE' in case of modules.  Static analysis tools
like scripts/checkkconfigsymbols.py, the Undertaker tools [1] or
Paul's perl monster rely on the assumption that 'CONFIG_' prefixed
symbols must be defined somewhere in a Kconfig file.  Sadly, this
naming convention is not  explicitly written down in any documentation
file.  Hence there are more than 250 cases in the source where
'CONFIG_' prefixed symbols are defined outside Kconfig (e.g., #define
CONFIG_IRQ_REQ [..] in drivers/pcmcia/cs_internal.h).  To give an
example, 65 of such cases are newly introduced with the gigantic AMD
driver mentioned in Linus' v4.2-rc1 log.

Since the naming convention is not made explicit, it can be hard to
convince people of not using the 'CONFIG_' prefix.  So here is my
question/proposal:  Do you agree on making the 'CONFIG_'  naming
convention explicit (e.g., in Documentation/CodingStyle)?  It would
simplify the life of people who check git trees for Kconfig issues and
report them, because a pointer to an explicit rule is more convincing
than explaining how Kbuild transforms a .config file.

Kind regards,
 Valentin

[1] https://undertaker.cs.fau.de/
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/