Commit 71a83ec7 authored by Artem Bityutskiy's avatar Artem Bityutskiy Committed by Michal Marek
Browse files

Kconfig: improve KALLSYMS_ALL documentation 



Dumb users like myself are not able to grasp from the existing KALLSYMS_ALL
documentation that this option is not what they need. Improve the help
message and make it clearer that KALLSYMS is enough in the majority of
use cases, and KALLSYMS_ALL should really be used very rarely.

Signed-off-by: default avatarArtem Bityutskiy <Artem.Bityutskiy@nokia.com>
Signed-off-by: default avatarMichal Marek <mmarek@suse.cz>
parent 0ce790e7

init/Kconfig

+12 −6
Original line number Diff line number Diff line
@@ -968,12 +968,18 @@ config KALLSYMS_ALL 
	bool "Include all symbols in kallsyms"

	depends on DEBUG_KERNEL && KALLSYMS

	help

	   Normally kallsyms only contains the symbols of functions, for nicer

	   OOPS messages.  Some debuggers can use kallsyms for other

	   symbols too: say Y here to include all symbols, if you need them 

	   and you don't care about adding 300k to the size of your kernel.



	   Say N.

	   Normally kallsyms only contains the symbols of functions for nicer

	   OOPS messages and backtraces (i.e., symbols from the text and inittext

	   sections). This is sufficient for most cases. And only in very rare

	   cases (e.g., when a debugger is used) all symbols are required (e.g.,

	   names of variables from the data sections, etc).



	   This option makes sure that all symbols are loaded into the kernel

	   image (i.e., symbols from all sections) in cost of increased kernel

	   size (depending on the kernel configuration, it may be 300KiB or

	   something like this).



	   Say N unless you really need all symbols.



config KALLSYMS_EXTRA_PASS

	bool "Do an extra kallsyms pass"

CRA Git | Maintained and supported by SUSTech CRA and CCSE