ARM: document DEBUG_UNCOMPRESS Kconfig option
authorRussell King <rmk+kernel@arm.linux.org.uk>
Wed, 17 Jul 2013 16:54:27 +0000 (17:54 +0100)
committerRussell King <rmk+kernel@arm.linux.org.uk>
Mon, 22 Jul 2013 11:03:50 +0000 (12:03 +0100)
commitb6992fa9a74862c5addb62cde1657c7479615d86
treef5b64f156217eeb9d4eeb554863bd03afd88bdb6
parent3b2f64d00c46e1e4e9bd0bb9bb12619adac27a4b
ARM: document DEBUG_UNCOMPRESS Kconfig option

This non-user visible option lacked any kind of documentation.  This
is quite common for non-user visible options; certian people can't
understand the point of documenting such options with help text.

However, here we have a case in point: developers don't understand the
option either, as they were thinking that when the option is not set,
the decompressor should produce no output what so ever.  This is
incorrect, as the purpose of this option is to control whether a
multiplatform kernel uses the kernel debugging macros to produce
output or not.

So let's document this via help rather than commentry to prevent others
falling into this misunderstanding.

Signed-off-by: Russell King <rmk+kernel@arm.linux.org.uk>
arch/arm/Kconfig.debug