aboutsummaryrefslogtreecommitdiffstats
path: root/docs/CommandGuide/llvm-build.pod
blob: 6f70ffe32cf31dd4467d9fe68a19df8519dd7db5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
=pod

=head1 NAME

llvm-build - LLVM Project Build Utility

=head1 SYNOPSIS

B<llvm-build> [I<options>]

=head1 DESCRIPTION

B<llvm-build> is a tool for working with LLVM projects that use the LLVMBuild
system for describing their components.

At heart, B<llvm-build> is responsible for loading, verifying, and manipulating
the project's component data. The tool is primarily designed for use in
implementing build systems and tools which need access to the project structure
information.

=head1 OPTIONS

=over

=item B<-h>, B<--help>

Print the builtin program help.

=item B<--source-root>=I<PATH>

If given, load the project at the given source root path. If this option is not
given, the location of the project sources will be inferred from the location of
the B<llvm-build> script itself.

=item B<--print-tree>

Print the component tree for the project.

=item B<--write-llvmbuild>

Write out new I<LLVMBuild.txt> files based on the loaded components. This is
useful for auto-upgrading the schema of the files.

=item B<--llvmbuild-source-root>=I<PATH>

If given, expect the I<LLVMBuild> files for the project to be rooted at the
given path, instead of inside the source tree itself. This option is primarily
designed for use in conjunction with B<--write-llvmbuild> to test changes to
I<LLVMBuild> schema.

=back

=head1 EXIT STATUS

B<llvm-build> exits with 0 if operation was successful. Otherwise, it will exist
with a non-zero value.

=head1 AUTHOR

Maintained by the LLVM Team (L<http://llvm.org/>).

=cut