Eric Lee / smarc-ti-linux-kernel

Download as
Browse Code ยป

Commit 71a83ec7da8910f374a1c82e96d2704aa45d9238

Authored by Artem Bityutskiy
Committed by Michal Marek
1 parent 0ce790e7d7
Exists in master and in 20 other branches dlt-processor-sdk-linux-03.00.00.04, newt-ti-linux-3.12.y, processor-sdk-linux-01.00.00, processor-sdk-linux-02.00.01, smarc-ti-linux-3.12.10, smarc-ti-linux-3.12.y, smarc-ti-linux-3.14.y, smarc-ti-linux-3.15.y, smarc-ti-lsk-linux-4.1.y, smarct3x-processor-sdk-04.01.00.06, smarct3x-processor-sdk-linux-02.00.01, smarct3x-processor-sdk-linux-03.00.00.04, smarct4x-800-processor-sdk-linux-02.00.01, smarct4x-processor-sdk-04.01.00.06, smarct4x-processor-sdk-linux-02.00.01, smarct4x-processor-sdk-linux-03.00.00.04, ti-linux-3.12.y, ti-linux-3.14.y, ti-linux-3.15.y, ti-lsk-linux-4.1.y

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: Artem Bityutskiy <Artem.Bityutskiy@nokia.com>
Signed-off-by: Michal Marek <mmarek@suse.cz>

Showing 1 changed file with 12 additions and 6 deletions Side-by-side Diff

... ... @@ -968,12 +968,18 @@
968 968 bool "Include all symbols in kallsyms"
969 969 depends on DEBUG_KERNEL && KALLSYMS
970 970 help
971   - Normally kallsyms only contains the symbols of functions, for nicer
972   - OOPS messages. Some debuggers can use kallsyms for other
973   - symbols too: say Y here to include all symbols, if you need them
974   - and you don't care about adding 300k to the size of your kernel.
  971 + Normally kallsyms only contains the symbols of functions for nicer
  972 + OOPS messages and backtraces (i.e., symbols from the text and inittext
  973 + sections). This is sufficient for most cases. And only in very rare
  974 + cases (e.g., when a debugger is used) all symbols are required (e.g.,
  975 + names of variables from the data sections, etc).
975 976  
976   - Say N.
  977 + This option makes sure that all symbols are loaded into the kernel
  978 + image (i.e., symbols from all sections) in cost of increased kernel
  979 + size (depending on the kernel configuration, it may be 300KiB or
  980 + something like this).
  981 +
  982 + Say N unless you really need all symbols.
977 983  
978 984 config KALLSYMS_EXTRA_PASS
979 985 bool "Do an extra kallsyms pass"