llvm.org GIT mirror llvm / 2adb2a5
docs: Sketch docs for llvm-build tool. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@143627 91177308-0d34-0410-b5e6-96231b3b80d8 Daniel Dunbar 7 years ago
3 changed file(s) with 68 addition(s) and 1 deletion(s). Raw diff Collapse all Expand all
4848 PS := $(patsubst $(SRC_DOC_DIR)%.pod, $(DST_PS_DIR)%.ps, $(POD))
4949
5050 # The set of man pages we will not install
51 NO_INSTALL_MANS = $(DST_MAN_DIR)FileCheck.1
51 NO_INSTALL_MANS = $(DST_MAN_DIR)FileCheck.1 $(DST_MAN_DIR)llvm-build.1
5252
5353 # The set of man pages that we will install
5454 INSTALL_MANS = $(filter-out $(NO_INSTALL_MANS), $(MAN))
0 =pod
1
2 =head1 NAME
3
4 llvm-build - LLVM Project Build Utility
5
6 =head1 SYNOPSIS
7
8 B [I]
9
10 =head1 DESCRIPTION
11
12 B is a tool for working with LLVM projects that use the LLVMBuild
13 system for describing their components.
14
15 At heart, B is responsible for loading, verifying, and manipulating
16 the project's component data. The tool is primarily designed for use in
17 implementing build systems and tools which need access to the project structure
18 information.
19
20 =head1 OPTIONS
21
22 =over
23
24 =item B<-h>, B<--help>
25
26 Print the builtin program help.
27
28 =item B<--source-root>=I
29
30 If given, load the project at the given source root path. If this option is not
31 given, the location of the project sources will be inferred from the location of
32 the B script itself.
33
34 =item B<--print-tree>
35
36 Print the component tree for the project.
37
38 =item B<--write-llvmbuild>
39
40 Write out new I files based on the loaded components. This is
41 useful for auto-upgrading the schema of the files.
42
43 =item B<--llvmbuild-source-root>=I
44
45 If given, expect the I files for the project to be rooted at the
46 given path, instead of inside the source tree itself. This option is primarily
47 designed for use in conjunction with B<--write-llvmbuild> to test changes to
48 I schema.
49
50 =back
51
52 =head1 EXIT STATUS
53
54 B exits with 0 if operation was successful. Otherwise, it will exist
55 with a non-zero value.
56
57 =head1 AUTHOR
58
59 Maintained by the LLVM Team (L).
60
61 =cut
8787 developers who are not working on the build system would only ever need to
8888 modify the contents of the LLVMBuild.txt description files (although we
8989 have not reached this goal yet).

90
91

For more information on the utility tool we provide to help interfacing

92 with the build system, please see
93 the llvm-build
94 documentation.

9095
9196
9297