I realized that the first time I tried to send this, it went out to the list without its patch attached. Sorry about that. Here is the patch. Comments appreciated.
http://reviews.llvm.org/D10234 Files: docs/tools/clang.pod Index: docs/tools/clang.pod =================================================================== --- docs/tools/clang.pod (revision 239013) +++ docs/tools/clang.pod (working copy) @@ -32,26 +32,26 @@ The B<clang> executable is actually a small driver which controls the overall execution of other tools such as the compiler, assembler and linker. Typically you do not need to interact with the driver, but you transparently use it to run the other tools. =item B<Preprocessing> This stage handles tokenization of the input source file, macro expansion, #include expansion and handling of other preprocessor directives. The output of this stage is typically called a ".i" (for C), ".ii" (for C++), ".mi" (for -Objective-C) , or ".mii" (for Objective-C++) file. +Objective-C), or ".mii" (for Objective-C++) file. =item B<Parsing and Semantic Analysis> This stage parses the input file, translating preprocessor tokens into a parse -tree. Once in the form of a parser tree, it applies semantic analysis to compute +tree. Once in the form of a parse tree, it applies semantic analysis to compute types for expressions as well and determine whether the code is well formed. This stage is responsible for generating most of the compiler warnings as well as parse errors. The output of this stage is an "Abstract Syntax Tree" (AST). =item B<Code Generation and Optimization> This stage translates an AST into low-level intermediate code (known as "LLVM IR") and ultimately to machine code. This phase is responsible for optimizing the generated code and handling target-specific code generation. The output of this stage is typically called a ".s" file or "assembly" file. @@ -323,27 +323,27 @@ C++ class in the module that contains the vtable for the class. The B<-fstandalone-debug> option turns off these optimizations. This is useful when working with 3rd-party libraries that don't come with debug information. This is the default on Darwin. Note that Clang will never emit type information for types that are not referenced at all by the program. =item B<-fexceptions> -Enable generation of unwind information, this allows exceptions to be thrown +Enable generation of unwind information. This allows exceptions to be thrown through Clang compiled stack frames. This is on by default in x86-64. =item B<-ftrapv> Generate code to catch integer overflow errors. Signed integer overflow is -undefined in C, with this flag, extra code is generated to detect this and abort +undefined in C. With this flag, extra code is generated to detect this and abort when it happens. =item B<-fvisibility> This flag sets the default visibility level. =item B<-fcommon> This flag specifies that variables without initializers get common linkage. It @@ -382,21 +382,21 @@ =item B<-###> Print (but do not run) the commands to run for this compilation. =item B<--help> Display available options. =item B<-Qunused-arguments> -Don't emit warning for unused driver arguments. +Don't emit any warning for unused driver arguments. =item B<-Wa,>I<args> Pass the comma separated arguments in I<args> to the assembler. =item B<-Wl,>I<args> Pass the comma separated arguments in I<args> to the linker. =item B<-Wp,>I<args> @@ -571,35 +571,35 @@ =item B<TMPDIR>, B<TEMP>, B<TMP> These environment variables are checked, in order, for the location to write temporary files used during the compilation process. =item B<CPATH> If this environment variable is present, it is treated as a delimited list of paths to be added to the default system include path list. The -delimiter is the platform dependent delimitor, as used in the I<PATH> +delimiter is the platform dependent delimiter, as used in the I<PATH> environment variable. Empty components in the environment variable are ignored. =item B<C_INCLUDE_PATH>, B<OBJC_INCLUDE_PATH>, B<CPLUS_INCLUDE_PATH>, B<OBJCPLUS_INCLUDE_PATH> These environment variables specify additional paths, as for CPATH, which are only used when processing the appropriate language. =item B<MACOSX_DEPLOYMENT_TARGET> If -mmacosx-version-min is unspecified, the default deployment target -is read from this environment variable. This option only affects darwin +is read from this environment variable. This option only affects Darwin targets. =back =head1 BUGS To report bugs, please visit L<http://llvm.org/bugs/>. Most bug reports should include preprocessed source files (use the B<-E> option) and the full output of the compiler, along with information to reproduce. _______________________________________________ cfe-commits mailing list [email protected] http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits
