mirror of
https://git.proxmox.com/git/llvm-toolchain
synced 2025-08-08 01:03:27 +00:00
add the manpage for clang-check
This commit is contained in:
Sylvestre Ledru
parent
2423b3f7b5
commit
3bef5507bf
1
debian/clang-3.3.manpages
vendored
1
debian/clang-3.3.manpages
vendored
@ -1,2 +1,3 @@
|
|||||||
build-llvm/tools/clang/docs/tools/clang-3.3.1
|
build-llvm/tools/clang/docs/tools/clang-3.3.1
|
||||||
clang/tools/scan-build/scan-build.1
|
clang/tools/scan-build/scan-build.1
|
||||||
|
debian/man/clang-check.1
|
||||||
|
|||||||
275
debian/man/clang-check.1
vendored
Normal file
275
debian/man/clang-check.1
vendored
Normal file
@ -0,0 +1,275 @@
|
|||||||
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.41.2.
|
||||||
|
.TH LLVM "1" "June 2013" "LLVM (http://llvm.org/):" "User Commands"
|
||||||
|
.SH NAME
|
||||||
|
LLVM \- manual page for LLVM (http://llvm.org/):
|
||||||
|
.SH DESCRIPTION
|
||||||
|
USAGE: clang\-check\-3.3 [options] <source0> [... <sourceN>]
|
||||||
|
.SS "OPTIONS:"
|
||||||
|
.HP
|
||||||
|
\fB\-asm\-verbose\fR \- Add comments to directives.
|
||||||
|
.HP
|
||||||
|
\fB\-ast\-dump\fR \- Build ASTs and then debug dump them
|
||||||
|
.HP
|
||||||
|
\fB\-ast\-dump\-filter=\fR<string> \- Use with \fB\-ast\-dump\fR or \fB\-ast\-print\fR to dump/print only AST declaration nodes having a certain substring in a qualified name. Use \fB\-ast\-list\fR to list all filterable declaration node names.
|
||||||
|
.HP
|
||||||
|
\fB\-ast\-list\fR \- Build ASTs and print the list of declaration node qualified names
|
||||||
|
.HP
|
||||||
|
\fB\-ast\-print\fR \- Build ASTs and then pretty\-print them
|
||||||
|
.HP
|
||||||
|
\fB\-bounds\-checking\-single\-trap\fR \- Use one trap block per function
|
||||||
|
.HP
|
||||||
|
\fB\-cppfname=\fR<function name> \- Specify the name of the generated function
|
||||||
|
.HP
|
||||||
|
\fB\-cppfor=\fR<string> \- Specify the name of the thing to generate
|
||||||
|
.HP
|
||||||
|
\fB\-cppgen\fR \- Choose what kind of output to generate
|
||||||
|
.TP
|
||||||
|
=program
|
||||||
|
\- Generate a complete program
|
||||||
|
.TP
|
||||||
|
=module
|
||||||
|
\- Generate a module definition
|
||||||
|
.TP
|
||||||
|
=contents
|
||||||
|
\- Generate contents of a module
|
||||||
|
.TP
|
||||||
|
=function
|
||||||
|
\- Generate a function definition
|
||||||
|
.TP
|
||||||
|
=functions
|
||||||
|
\- Generate all function definitions
|
||||||
|
.TP
|
||||||
|
=inline
|
||||||
|
\- Generate an inline function
|
||||||
|
.TP
|
||||||
|
=variable
|
||||||
|
\- Generate a variable definition
|
||||||
|
.TP
|
||||||
|
=type
|
||||||
|
\- Generate a type definition
|
||||||
|
.HP
|
||||||
|
\fB\-disable\-spill\-fusing\fR \- Disable fusing of spill code into instructions
|
||||||
|
.IP
|
||||||
|
Choose driver interface:
|
||||||
|
.HP
|
||||||
|
\fB\-drvnvcl\fR \- Nvidia OpenCL driver
|
||||||
|
.HP
|
||||||
|
\fB\-drvcuda\fR \- Nvidia CUDA driver
|
||||||
|
.HP
|
||||||
|
\fB\-drvtest\fR \- Plain Test
|
||||||
|
.HP
|
||||||
|
\fB\-enable\-correct\-eh\-support\fR \- Make the \fB\-lowerinvoke\fR pass insert expensive, but correct, EH code
|
||||||
|
.HP
|
||||||
|
\fB\-enable\-load\-pre\fR \-
|
||||||
|
.HP
|
||||||
|
\fB\-enable\-objc\-arc\-opts\fR \- enable/disable all ARC Optimizations
|
||||||
|
.HP
|
||||||
|
\fB\-enable\-tbaa\fR \-
|
||||||
|
.HP
|
||||||
|
\fB\-fatal\-assembler\-warnings\fR \- Consider warnings as error
|
||||||
|
.HP
|
||||||
|
\fB\-fdata\-sections\fR \- Emit data into separate sections
|
||||||
|
.HP
|
||||||
|
\fB\-ffunction\-sections\fR \- Emit functions into separate sections
|
||||||
|
.HP
|
||||||
|
\fB\-fix\-what\-you\-can\fR \- Apply fix\-it advice even in the presence of unfixable errors
|
||||||
|
.HP
|
||||||
|
\fB\-fixit\fR \- Apply fix\-it advice to the input source
|
||||||
|
.HP
|
||||||
|
\fB\-help\fR \- Display available options (\fB\-help\-hidden\fR for more)
|
||||||
|
.HP
|
||||||
|
\fB\-internalize\-public\-api\-file=\fR<filename> \- A file containing list of symbol names to preserve
|
||||||
|
.HP
|
||||||
|
\fB\-internalize\-public\-api\-list=\fR<list> \- A list of symbol names to preserve
|
||||||
|
.HP
|
||||||
|
\fB\-join\-liveintervals\fR \- Coalesce copies (default=true)
|
||||||
|
.HP
|
||||||
|
\fB\-limit\-float\-precision=\fR<uint> \- Generate low\-precision inline sequences for some float libcalls
|
||||||
|
.HP
|
||||||
|
\fB\-mc\-x86\-disable\-arith\-relaxation\fR \- Disable relaxation of arithmetic instruction for X86
|
||||||
|
.HP
|
||||||
|
\fB\-mips16\-hard\-float\fR \- MIPS: mips16 hard float enable.
|
||||||
|
.HP
|
||||||
|
\fB\-msp430\-hwmult\-mode\fR \- Hardware multiplier use mode
|
||||||
|
.TP
|
||||||
|
=no
|
||||||
|
\- Do not use hardware multiplier
|
||||||
|
.TP
|
||||||
|
=interrupts
|
||||||
|
\- Assume hardware multiplier can be used inside interrupts
|
||||||
|
.TP
|
||||||
|
=use
|
||||||
|
\- Assume hardware multiplier cannot be used inside interrupts
|
||||||
|
.HP
|
||||||
|
\fB\-nvptx\-emit\-line\-numbers\fR \- NVPTX Specific: Emit Line numbers even without \fB\-G\fR
|
||||||
|
.HP
|
||||||
|
\fB\-nvptx\-emit\-src\fR \- NVPTX Specific: Emit source line in ptx file
|
||||||
|
.TP
|
||||||
|
\fB\-nvptx\-fma\-level=\fR<int> \- NVPTX Specific: FMA contraction (0: don't do it 1: do it
|
||||||
|
2: do it aggressively
|
||||||
|
.HP
|
||||||
|
\fB\-nvptx\-mad\-enable\fR \- NVPTX Specific: Enable generating FMAD instructions
|
||||||
|
.HP
|
||||||
|
\fB\-nvptx\-prec\-divf32=\fR<int> \- NVPTX Specifies: 0 use div.approx, 1 use div.full, 2 use IEEE Compliant F32 div.rnd if avaiable.
|
||||||
|
.HP
|
||||||
|
\fB\-nvptx\-sched4reg\fR \- NVPTX Specific: schedule for register pressue
|
||||||
|
.HP
|
||||||
|
\fB\-nvvm\-reflect\-enable\fR \- NVVM reflection, enabled by default
|
||||||
|
.HP
|
||||||
|
\fB\-nvvm\-reflect\-list=\fR<name=<int>> \- A list of string=num assignments
|
||||||
|
.HP
|
||||||
|
\fB\-p=\fR<string> \- Build path
|
||||||
|
.HP
|
||||||
|
\fB\-pre\-RA\-sched\fR \- Instruction schedulers available (before register allocation):
|
||||||
|
.TP
|
||||||
|
=vliw\-td
|
||||||
|
\- VLIW scheduler
|
||||||
|
.TP
|
||||||
|
=list\-ilp
|
||||||
|
\- Bottom\-up register pressure aware list scheduling which tries to balance ILP and register pressure
|
||||||
|
.TP
|
||||||
|
=list\-hybrid
|
||||||
|
\- Bottom\-up register pressure aware list scheduling which tries to balance latency and register pressure
|
||||||
|
.TP
|
||||||
|
=source
|
||||||
|
\- Similar to list\-burr but schedules in source order when possible
|
||||||
|
.TP
|
||||||
|
=list\-burr
|
||||||
|
\- Bottom\-up register reduction list scheduling
|
||||||
|
.TP
|
||||||
|
=linearize
|
||||||
|
\- Linearize DAG, no scheduling
|
||||||
|
.TP
|
||||||
|
=fast
|
||||||
|
\- Fast suboptimal list scheduling
|
||||||
|
.TP
|
||||||
|
=default
|
||||||
|
\- Best scheduler for the target
|
||||||
|
.HP
|
||||||
|
\fB\-print\-after\-all\fR \- Print IR after each pass
|
||||||
|
.HP
|
||||||
|
\fB\-print\-before\-all\fR \- Print IR before each pass
|
||||||
|
.HP
|
||||||
|
\fB\-print\-machineinstrs=\fR<pass\-name> \- Print machine instrs
|
||||||
|
.HP
|
||||||
|
\fB\-profile\-estimator\-loop\-weight=\fR<loop\-weight> \- Number of loop executions used for profile\-estimator
|
||||||
|
.HP
|
||||||
|
\fB\-profile\-file=\fR<filename> \- Profile file loaded by \fB\-profile\-metadata\-loader\fR
|
||||||
|
.HP
|
||||||
|
\fB\-profile\-info\-file=\fR<filename> \- Profile file loaded by \fB\-profile\-loader\fR
|
||||||
|
.HP
|
||||||
|
\fB\-profile\-verifier\-noassert\fR \- Disable assertions
|
||||||
|
.HP
|
||||||
|
\fB\-regalloc\fR \- Register allocator to use
|
||||||
|
.TP
|
||||||
|
=default
|
||||||
|
\- pick register allocator based on \fB\-O\fR option
|
||||||
|
.TP
|
||||||
|
=basic
|
||||||
|
\- basic register allocator
|
||||||
|
.TP
|
||||||
|
=fast
|
||||||
|
\- fast register allocator
|
||||||
|
.TP
|
||||||
|
=greedy
|
||||||
|
\- greedy register allocator
|
||||||
|
.TP
|
||||||
|
=pbqp
|
||||||
|
\- PBQP register allocator
|
||||||
|
.HP
|
||||||
|
\fB\-shrink\-wrap\fR \- Shrink wrap callee\-saved register spills/restores
|
||||||
|
.HP
|
||||||
|
\fB\-spiller\fR \- Spiller to use: (default: standard)
|
||||||
|
.TP
|
||||||
|
=trivial
|
||||||
|
\- trivial spiller
|
||||||
|
.TP
|
||||||
|
=inline
|
||||||
|
\- inline spiller
|
||||||
|
.HP
|
||||||
|
\fB\-stats\fR \- Enable statistics output from program (available with Asserts)
|
||||||
|
.HP
|
||||||
|
\fB\-struct\-path\-tbaa\fR \-
|
||||||
|
.HP
|
||||||
|
\fB\-time\-passes\fR \- Time each pass, printing elapsed time for each on exit
|
||||||
|
.HP
|
||||||
|
\fB\-vectorize\-loops\fR \- Run the Loop vectorization passes
|
||||||
|
.HP
|
||||||
|
\fB\-vectorize\-slp\fR \- Run the SLP vectorization passes
|
||||||
|
.HP
|
||||||
|
\fB\-vectorize\-slp\-aggressive\fR \- Run the BB vectorization passes
|
||||||
|
.HP
|
||||||
|
\fB\-verify\-dom\-info\fR \- Verify dominator info (time consuming)
|
||||||
|
.HP
|
||||||
|
\fB\-verify\-loop\-info\fR \- Verify loop info (time consuming)
|
||||||
|
.HP
|
||||||
|
\fB\-verify\-regalloc\fR \- Verify during register allocation
|
||||||
|
.HP
|
||||||
|
\fB\-verify\-region\-info\fR \- Verify region info (time consuming)
|
||||||
|
.HP
|
||||||
|
\fB\-verify\-scev\fR \- Verify ScalarEvolution's backedge taken counts (slow)
|
||||||
|
.HP
|
||||||
|
\fB\-version\fR \- Display the version of this program
|
||||||
|
.HP
|
||||||
|
\fB\-x86\-asm\-syntax\fR \- Choose style of code to emit from X86 backend:
|
||||||
|
.TP
|
||||||
|
=att
|
||||||
|
\- Emit AT&T\-style assembly
|
||||||
|
.TP
|
||||||
|
=intel
|
||||||
|
\- Emit Intel\-style assembly
|
||||||
|
.HP
|
||||||
|
\fB\-x86\-early\-ifcvt\fR \- Enable early if\-conversion on X86
|
||||||
|
.HP
|
||||||
|
\fB\-x86\-use\-vzeroupper\fR \- Minimize AVX to SSE transition penalty
|
||||||
|
.PP
|
||||||
|
\fB\-p\fR <build\-path> is used to read a compile command database.
|
||||||
|
.IP
|
||||||
|
For example, it can be a CMake build directory in which a file named
|
||||||
|
compile_commands.json exists (use \fB\-DCMAKE_EXPORT_COMPILE_COMMANDS\fR=\fION\fR
|
||||||
|
CMake option to get this output). When no build path is specified,
|
||||||
|
a search for compile_commands.json will be attempted through all
|
||||||
|
parent paths of the first input file . See:
|
||||||
|
http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html for an
|
||||||
|
example of setting up Clang Tooling on a source tree.
|
||||||
|
.PP
|
||||||
|
<source0> ... specify the paths of source files. These paths are
|
||||||
|
.IP
|
||||||
|
looked up in the compile command database. If the path of a file is
|
||||||
|
absolute, it needs to point into CMake's source tree. If the path is
|
||||||
|
relative, the current working directory needs to be in the CMake
|
||||||
|
source tree and the file must be in a subdirectory of the current
|
||||||
|
working directory. "./" prefixes in the relative files will be
|
||||||
|
automatically removed, but the rest of a relative path must be a
|
||||||
|
suffix of a path in the compile command database.
|
||||||
|
.IP
|
||||||
|
For example, to run clang\-check on all files in a subtree of the
|
||||||
|
source tree, use:
|
||||||
|
.IP
|
||||||
|
find path/in/subtree \fB\-name\fR '*.cpp'|xargs clang\-check
|
||||||
|
.IP
|
||||||
|
or using a specific build path:
|
||||||
|
.IP
|
||||||
|
find path/in/subtree \fB\-name\fR '*.cpp'|xargs clang\-check \fB\-p\fR build/path
|
||||||
|
.IP
|
||||||
|
Note, that path/in/subtree and current directory should follow the
|
||||||
|
rules described above.
|
||||||
|
.IP
|
||||||
|
LLVM version 3.3
|
||||||
|
.IP
|
||||||
|
Optimized build.
|
||||||
|
Built May 7 2013 (21:07:59).
|
||||||
|
Default target: x86_64\-pc\-linux\-gnu
|
||||||
|
Host CPU: corei7\-avx
|
||||||
|
.SH "SEE ALSO"
|
||||||
|
The full documentation for
|
||||||
|
.B LLVM
|
||||||
|
is maintained as a Texinfo manual. If the
|
||||||
|
.B info
|
||||||
|
and
|
||||||
|
.B LLVM
|
||||||
|
programs are properly installed at your site, the command
|
||||||
|
.IP
|
||||||
|
.B info LLVM
|
||||||
|
.PP
|
||||||
|
should give you access to the complete manual.
|
||||||
Loading…
Reference in New Issue
Block a user