From ca74157283dd43d0036ab6b7b9380300728a7e97 Mon Sep 17 00:00:00 2001 From: Tao Liu Date: Tue, 5 Nov 2024 15:59:32 +1300 Subject: [PATCH] Doc: add doc to state that the --log option is deprecated Since kernel(>=v5.10), a new lockless ringbuffer is introduced. And crash commit a5531b24 ("printk: add support for lockless ringbuffer") implemented the lockless ringbuffer dumping for cmd_log, this however, relies on the existence of kernel debuginfo. Since there is already a similar function been implemented for makedumpfile, aka "makedumpfile --dump-dmesg" to dump dmesg logs with only vmcore, there is no need to maintain a similar code in crash as well. In addition, this option is not widely used, so just state the "--log" option is deprecated. Signed-off-by: Tao Liu --- crash.8 | 2 ++ help.c | 2 ++ 2 files changed, 4 insertions(+) diff --git a/crash.8 b/crash.8 index 0662f92..c7dc27d 100644 --- a/crash.8 +++ b/crash.8 @@ -337,6 +337,8 @@ devices. Dump the contents of the kernel log buffer. A kernel namelist argument is not necessary, but the dumpfile must contain the VMCOREINFO data taken from the original /proc/vmcore ELF header. +Note: this option is deprecated and will no longer work for +kernel(>=v5.10). .TP .B --no_kallsyms Do not use kallsyms-generated symbol information contained within diff --git a/help.c b/help.c index e95ac1d..0a76d38 100644 --- a/help.c +++ b/help.c @@ -215,6 +215,8 @@ char *program_usage_info[] = { " Dump the contents of the kernel log buffer. A kernel namelist", " argument is not necessary, but the dumpfile must contain the", " VMCOREINFO data taken from the original /proc/vmcore ELF header.", + " Note: this option is deprecated and will no longer work for", + " kernel(>=v5.10).", "", " --no_kallsyms", " Do not use kallsyms-generated symbol information contained within",