Commit b6992fa9 authored Jul 17, 2013 by Russell King

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>

parent 3b2f64d0

arch/arm/Kconfig.debug

+12 −2

Original line number	Diff line number	Diff line
		@@ -804,9 +804,19 @@ config DEBUG_LL_INCLUDE

		config DEBUG_UNCOMPRESS
		bool
		default y if ARCH_MULTIPLATFORM && DEBUG_LL && \
		!DEBUG_OMAP2PLUS_UART && \
		depends on ARCH_MULTIPLATFORM
		default y if DEBUG_LL && !DEBUG_OMAP2PLUS_UART && \
		!DEBUG_TEGRA_UART
		help
		This option influences the normal decompressor output for
		multiplatform kernels. Normally, multiplatform kernels disable
		decompressor output because it is not possible to know where to
		send the decompressor output.

		When this option is set, the selected DEBUG_LL output method
		will be re-used for normal decompressor output on multiplatform
		kernels.


		config UNCOMPRESS_INCLUDE
		string

Admin message