Signed-off-by: Tao Liu <[email protected]> --- makedumpfile.8.in | 24 +++++++++++++++--------- print_info.c | 11 +++++------ 2 files changed, 20 insertions(+), 15 deletions(-)
diff --git a/makedumpfile.8.in b/makedumpfile.8.in index d22588e..acc4405 100644 --- a/makedumpfile.8.in +++ b/makedumpfile.8.in @@ -6,7 +6,7 @@ makedumpfile \- make a small dumpfile of kdump .br \fBmakedumpfile\fR \-F [\fIOPTION\fR] [\-x \fIVMLINUX\fR|\-i \fIVMCOREINFO\fR] \fIVMCORE\fR .br -\fBmakedumpfile\fR [\fIOPTION\fR] \-x \fIVMLINUX\fR [\-\-config \fIFILTERCONFIGFILE\fR] [\-\-eppic \fIEPPICMACRO\fR] \fIVMCORE\fR \fIDUMPFILE\fR +\fBmakedumpfile\fR [\fIOPTION\fR] [\-x \fIVMLINUX\fR] [\-\-config \fIFILTERCONFIGFILE\fR] [\-\-eppic \fIEPPICMACRO\fR] \fIVMCORE\fR \fIDUMPFILE\fR .br \fBmakedumpfile\fR \-R \fIDUMPFILE\fR .br @@ -54,6 +54,8 @@ be excluded. .B \- User process data pages .br .B \- Free pages +.br +.B \- Customized pages which specified by eppic macro .PP makedumpfile provides two \fIDUMPFILE\fR formats (the ELF format and the kdump\-compressed format). By default, makedumpfile makes a \fIDUMPFILE\fR in @@ -72,10 +74,10 @@ filter commands. The memory locations that require to be filtered out are then poisoned with character 'X' (58 in Hex). Refer to \fBmakedumpfile.conf(5)\fR for file format. .PP -Eppic macros can also be used to specify kernel symbols and its members that -need to be filtered. Eppic provides C semantics including language constructs -such as conditional statements, logical and arithmetic operators, functions, -nested loops to traverse and erase kernel data. --eppic requires +Eppic macros can also be used to specify kernel pages or kernel symbols and its +members that need to be filtered. Eppic provides C semantics including language +constructs such as conditional statements, logical and arithmetic operators, +functions, nested loops to traverse and erase kernel data. --eppic requires \fBeppic_makedumpfile.so\fR and eppic library. \fBeppic_makedumpfile.so\fR can be built from makedumpfile source. Refer to \fBhttp://code.google.com/p/eppic/\fR to build eppic library \fBlibeppic.a\fR @@ -316,10 +318,14 @@ command syntax please refer to \fBmakedumpfile.conf(5)\fR. .TP \fB\-\-eppic\fR \fIEPPICMACRO\fR -Used in conjunction with \-x \fIVMLINUX\fR option, to specify the eppic macro -file that contains filter rules or directory that contains eppic macro -files to filter out desired kernel data from vmcore while creating \fIDUMPFILE\fR. -When directory is specified, all the eppic macros in the directory are processed. +To specify the eppic macro file that contains filter rules or directory that +contains eppic macro files to filter out desired kernel data/pages from vmcore +while creating \fIDUMPFILE\fR. When directory is specified, all the eppic macros +in the directory are processed. Please note, if the option is used in conjunction +with \-x \fIVMLINUX\fR option, makedumpfile will use the dwarf data of +\fIVMLINUX\fR as debuginfo for symbol resolving; otherwise, btf & kallsyms +data(if available) of \fIVMCORE\fR will be used instead. Rust symbols are not +supported in eppic macro file. .TP \fB\-F\fR diff --git a/print_info.c b/print_info.c index 8d3b1cb..60b1657 100644 --- a/print_info.c +++ b/print_info.c @@ -77,7 +77,7 @@ print_usage(void) MSG("\n"); MSG(" Creating DUMPFILE with filtered kernel data specified through filter config\n"); MSG(" file or eppic macro:\n"); - MSG(" # makedumpfile [-c|-l|-p|-z|-E] [-d DL] -x VMLINUX [--config FILTERCONFIGFILE]\n"); + MSG(" # makedumpfile [-c|-l|-p|-z|-E] [-d DL] [-x VMLINUX] [--config FILTERCONFIGFILE]\n"); MSG(" [--eppic EPPICMACRO] VMCORE DUMPFILE\n"); MSG("\n"); MSG(" Outputting the dump data in the flattened format to the standard output:\n"); @@ -190,11 +190,10 @@ print_usage(void) MSG(" from vmcore while creating DUMPFILE.\n"); MSG("\n"); MSG(" [--eppic EPPICMACRO]:\n"); - MSG(" Used in conjunction with -x VMLINUX option, to specify the eppic macro\n"); - MSG(" file that contains filter rules or directory that contains eppic macro\n"); - MSG(" files to filter out desired kernel data from vmcore while creating DUMPFILE.\n"); - MSG(" When directory is specified, all the eppic macros in the directory are\n"); - MSG(" processed\n"); + MSG(" To specify the eppic macro file that contains filter rules or directory\n"); + MSG(" that contains eppic macro files to filter out desired kernel data/pages\n"); + MSG(" from vmcore while creating DUMPFILE. When directory is specified, all the\n"); + MSG(" eppic macros in the directory are processed\n"); MSG("\n"); MSG(" [-F]:\n"); MSG(" Output the dump data in the flattened format to the standard output\n"); -- 2.47.0
