From 3277b69d734b9c90b44ebde4ede005717e2c3b2e Mon Sep 17 00:00:00 2001 From: ed Date: Tue, 2 Jun 2009 17:52:33 +0000 Subject: Import LLVM, at r72732. --- docs/CommandGuide/llvm-extract.pod | 63 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 63 insertions(+) create mode 100644 docs/CommandGuide/llvm-extract.pod (limited to 'docs/CommandGuide/llvm-extract.pod') diff --git a/docs/CommandGuide/llvm-extract.pod b/docs/CommandGuide/llvm-extract.pod new file mode 100644 index 0000000..d916612 --- /dev/null +++ b/docs/CommandGuide/llvm-extract.pod @@ -0,0 +1,63 @@ +=pod + +=head1 NAME + +llvm-extract - extract a function from an LLVM module + +=head1 SYNOPSIS + +B [I] B<--func> I [I] + +=head1 DESCRIPTION + +The B command takes the name of a function and extracts it from +the specified LLVM bitcode file. It is primarily used as a debugging tool to +reduce test cases from larger programs that are triggering a bug. + +In addition to extracting the bitcode of the specified function, +B will also remove unreachable global variables, prototypes, and +unused types. + +The B command reads its input from standard input if filename is +omitted or if filename is -. The output is always written to standard output, +unless the B<-o> option is specified (see below). + +=head1 OPTIONS + +=over + +=item B<-f> + +Force overwrite. Normally, B will refuse to overwrite an +output file that already exists. With this option, B +will overwrite the output file and replace it with new bitcode. + +=item B<--func> I + +Extract the function named I from the LLVM bitcode. + +=item B<--help> + +Print a summary of command line options. + +=item B<-o> I + +Specify the output filename. If filename is "-" (the default), then +B sends its output to standard output. + +=back + +=head1 EXIT STATUS + +If B succeeds, it will exit with 0. Otherwise, if an error +occurs, it will exit with a non-zero value. + +=head1 SEE ALSO + +L + +=head1 AUTHORS + +Maintained by the LLVM Team (L). + +=cut -- cgit v1.1