From 0cabaa54e512420f3057ffe781ff317ecb9196ed Mon Sep 17 00:00:00 2001 From: Dan Gohman Date: Tue, 25 Aug 2009 15:54:01 +0000 Subject: [PATCH] Update documentation for the -f change. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@79996 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/CodeGenerator.html | 6 +++--- docs/CommandGuide/llc.pod | 5 +++-- docs/CommandGuide/llvm-as.pod | 6 +++--- docs/CommandGuide/llvm-dis.pod | 6 +++--- docs/CommandGuide/llvm-extract.pod | 6 +++--- docs/CommandGuide/llvm-link.pod | 5 +++-- docs/CommandGuide/opt.pod | 6 +++--- docs/CommandLine.html | 18 +++++++++--------- docs/HowToSubmitABug.html | 14 +++++++------- 9 files changed, 37 insertions(+), 35 deletions(-) diff --git a/docs/CodeGenerator.html b/docs/CodeGenerator.html index 2f716a2161a..4f8472c07fa 100644 --- a/docs/CodeGenerator.html +++ b/docs/CodeGenerator.html @@ -1616,9 +1616,9 @@ bool RegMapping_Fer::compatible_class(MachineFunction &mf, 
-$ llc -f -regalloc=simple file.bc -o sp.s;
-$ llc -f -regalloc=local file.bc -o lc.s;
-$ llc -f -regalloc=linearscan file.bc -o ln.s;
+$ llc -regalloc=simple file.bc -o sp.s;
+$ llc -regalloc=local file.bc -o lc.s;
+$ llc -regalloc=linearscan file.bc -o ln.s;
diff --git a/docs/CommandGuide/llc.pod b/docs/CommandGuide/llc.pod index eba7859e288..7a7bbcac9c5 100644 --- a/docs/CommandGuide/llc.pod +++ b/docs/CommandGuide/llc.pod @@ -49,8 +49,9 @@ B. =item B<-f> -Overwrite output files. By default, B will refuse to overwrite -an output file which already exists. +Enable binary output on terminals. Normally, B will refuse to +write raw bitcode output if the output stream is a terminal. With this option, +B will write raw bitcode regardless of the output device. =item B<-mtriple>=I diff --git a/docs/CommandGuide/llvm-as.pod b/docs/CommandGuide/llvm-as.pod index 2befed13ae0..045a9245b60 100644 --- a/docs/CommandGuide/llvm-as.pod +++ b/docs/CommandGuide/llvm-as.pod @@ -46,9 +46,9 @@ suffix is appended. =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. +Enable binary output on terminals. Normally, B will refuse to +write raw bitcode output if the output stream is a terminal. With this option, +B will write raw bitcode regardless of the output device. =item B<--help> diff --git a/docs/CommandGuide/llvm-dis.pod b/docs/CommandGuide/llvm-dis.pod index 8df382d2e9c..2b83290c9b2 100644 --- a/docs/CommandGuide/llvm-dis.pod +++ b/docs/CommandGuide/llvm-dis.pod @@ -29,9 +29,9 @@ B<-o> option. =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. +Enable binary output on terminals. Normally, B will refuse to +write raw bitcode output if the output stream is a terminal. With this option, +B will write raw bitcode regardless of the output device. =item B<--help> diff --git a/docs/CommandGuide/llvm-extract.pod b/docs/CommandGuide/llvm-extract.pod index d916612ec5c..c3bc019c6b8 100644 --- a/docs/CommandGuide/llvm-extract.pod +++ b/docs/CommandGuide/llvm-extract.pod @@ -28,9 +28,9 @@ unless the B<-o> option is specified (see below). =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. +Enable binary output on terminals. Normally, B will refuse to +write raw bitcode output if the output stream is a terminal. With this option, +B will write raw bitcode regardless of the output device. =item B<--func> I diff --git a/docs/CommandGuide/llvm-link.pod b/docs/CommandGuide/llvm-link.pod index 5f4dcb6e354..8a2a8c5d770 100644 --- a/docs/CommandGuide/llvm-link.pod +++ b/docs/CommandGuide/llvm-link.pod @@ -33,8 +33,9 @@ the order in which they were specified on the command line. =item B<-f> -Overwrite output files. By default, B will not overwrite an output -file if it already exists. +Enable binary output on terminals. Normally, B will refuse to +write raw bitcode output if the output stream is a terminal. With this option, +B will write raw bitcode regardless of the output device. =item B<-o> F diff --git a/docs/CommandGuide/opt.pod b/docs/CommandGuide/opt.pod index 75b7eddd4cf..3e23cd1ae65 100644 --- a/docs/CommandGuide/opt.pod +++ b/docs/CommandGuide/opt.pod @@ -39,9 +39,9 @@ writes its output to the standard output. =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. +Enable binary output on terminals. Normally, B will refuse to +write raw bitcode output if the output stream is a terminal. With this option, +B will write raw bitcode regardless of the output device. =item B<-help> diff --git a/docs/CommandLine.html b/docs/CommandLine.html index 09ed2b8c0e5..f14defc31f4 100644 --- a/docs/CommandLine.html +++ b/docs/CommandLine.html @@ -331,13 +331,13 @@ OPTIONS:

In addition to input and output filenames, we would like the compiler example -to support three boolean flags: "-f" to force overwriting of the output -file, "--quiet" to enable quiet mode, and "-q" for backwards -compatibility with some of our users. We can support these by declaring options -of boolean type like this:

+to support three boolean flags: "-f" to force writing binary output to +a terminal, "--quiet" to enable quiet mode, and "-q" for +backwards compatibility with some of our users. We can support these by +declaring options of boolean type like this:

-cl::opt<bool> Force ("f", cl::desc("Overwrite output files"));
+cl::opt<bool> Force ("f", cl::desc("Enable binary output on terminals"));
 cl::opt<bool> Quiet ("quiet", cl::desc("Don't print informational messages"));
 cl::opt<bool> Quiet2("q", cl::desc("Don't print informational messages"), cl::Hidden);
@@ -378,7 +378,7 @@ library calls to parse the string value into the specified data type.

USAGE: compiler [options] <input file> OPTIONS: - -f - Overwrite output files + -f - Enable binary output on terminals -o - Override output filename -quiet - Don't print informational messages -help - display available options (--help-hidden for more) @@ -390,7 +390,7 @@ OPTIONS: USAGE: compiler [options] <input file> OPTIONS: - -f - Overwrite output files + -f - Enable binary output on terminals -o - Override output filename -q - Don't print informational messages -quiet - Don't print informational messages @@ -530,7 +530,7 @@ OPTIONS: -O1 - Enable trivial optimizations -O2 - Enable default optimizations -O3 - Enable expensive optimizations - -f - Overwrite output files + -f - Enable binary output on terminals -help - display available options (--help-hidden for more) -o <filename> - Specify output filename -quiet - Don't print informational messages @@ -614,7 +614,7 @@ OPTIONS: =none - disable debug information =quick - enable quick debug information =detailed - enable detailed debug information - -f - Overwrite output files + -f - Enable binary output on terminals -help - display available options (--help-hidden for more) -o <filename> - Specify output filename -quiet - Don't print informational messages diff --git a/docs/HowToSubmitABug.html b/docs/HowToSubmitABug.html index bdec1c09109..91d4e2bfe98 100644 --- a/docs/HowToSubmitABug.html +++ b/docs/HowToSubmitABug.html @@ -183,12 +183,12 @@ to llvm-gcc (in addition to the options you already pass). Once your have foo.bc, one of the following commands should fail:

    -
  1. llc foo.bc -f
    2. -
  2. llc foo.bc -f -relocation-model=pic
    3. -
  3. llc foo.bc -f -relocation-model=static
    4. -
  4. llc foo.bc -f -enable-eh
    5. -
  5. llc foo.bc -f -relocation-model=pic -enable-eh
    6. -
  6. llc foo.bc -f -relocation-model=static -enable-eh
    7. +
  7. llc foo.bc
    8. +
  8. llc foo.bc -relocation-model=pic
    9. +
  9. llc foo.bc -relocation-model=static
    10. +
  10. llc foo.bc -enable-eh
    11. +
  11. llc foo.bc -relocation-model=pic -enable-eh
    12. +
  12. llc foo.bc -relocation-model=static -enable-eh

If none of these crash, please follow the instructions for a @@ -320,7 +320,7 @@ the following:

-llc test.bc -o test.s -f
+llc test.bc -o test.s
gcc test.s safe.so -o test.llc
./test.llc [program options]

-- 2.34.1