Skip to content

Commit

Permalink
Kconfig: improve KALLSYMS_ALL documentation
Browse files Browse the repository at this point in the history
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: Artem Bityutskiy <[email protected]>
Signed-off-by: Michal Marek <[email protected]>
  • Loading branch information
Artem Bityutskiy authored and michal42 committed Apr 15, 2011
1 parent 0ce790e commit 71a83ec
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions init/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down

0 comments on commit 71a83ec

Please sign in to comment.