| Daniel Dunbar | 2adb2a5 | 2011-11-03 17:56:24 +0000 | [diff] [blame] | 1 | =pod |
| 2 | |
| 3 | =head1 NAME |
| 4 | |
| 5 | llvm-build - LLVM Project Build Utility |
| 6 | |
| 7 | =head1 SYNOPSIS |
| 8 | |
| 9 | B<llvm-build> [I<options>] |
| 10 | |
| 11 | =head1 DESCRIPTION |
| 12 | |
| 13 | B<llvm-build> is a tool for working with LLVM projects that use the LLVMBuild |
| 14 | system for describing their components. |
| 15 | |
| 16 | At heart, B<llvm-build> is responsible for loading, verifying, and manipulating |
| 17 | the project's component data. The tool is primarily designed for use in |
| 18 | implementing build systems and tools which need access to the project structure |
| 19 | information. |
| 20 | |
| 21 | =head1 OPTIONS |
| 22 | |
| 23 | =over |
| 24 | |
| 25 | =item B<-h>, B<--help> |
| 26 | |
| 27 | Print the builtin program help. |
| 28 | |
| 29 | =item B<--source-root>=I<PATH> |
| 30 | |
| 31 | If given, load the project at the given source root path. If this option is not |
| 32 | given, the location of the project sources will be inferred from the location of |
| 33 | the B<llvm-build> script itself. |
| 34 | |
| 35 | =item B<--print-tree> |
| 36 | |
| 37 | Print the component tree for the project. |
| 38 | |
| Daniel Dunbar | efe2f64 | 2011-11-03 17:56:28 +0000 | [diff] [blame] | 39 | =item B<--write-library-table> |
| 40 | |
| 41 | Write out the C++ fragment which defines the components, library names, and |
| 42 | required libraries. This C++ fragment is built into L<llvm-config|llvm-config> |
| 43 | in order to provide clients with the list of required libraries for arbitrary |
| 44 | component combinations. |
| 45 | |
| Daniel Dunbar | 2adb2a5 | 2011-11-03 17:56:24 +0000 | [diff] [blame] | 46 | =item B<--write-llvmbuild> |
| 47 | |
| 48 | Write out new I<LLVMBuild.txt> files based on the loaded components. This is |
| Daniel Dunbar | a321716 | 2011-12-12 22:45:35 +0000 | [diff] [blame] | 49 | useful for auto-upgrading the schema of the files. B<llvm-build> will try to a |
| 50 | limited extent to preserve the comments which were written in the original |
| 51 | source file, although at this time it only preserves block comments that preceed |
| 52 | the section names in the I<LLVMBuild> files. |
| Daniel Dunbar | 2adb2a5 | 2011-11-03 17:56:24 +0000 | [diff] [blame] | 53 | |
| Daniel Dunbar | 1688961 | 2011-11-04 23:10:37 +0000 | [diff] [blame] | 54 | =item B<--write-cmake-fragment> |
| 55 | |
| 56 | Write out the LLVMBuild in the form of a CMake fragment, so it can easily be |
| 57 | consumed by the CMake based build system. The exact contents and format of this |
| 58 | file are closely tied to how LLVMBuild is integrated with CMake, see LLVM's |
| 59 | top-level CMakeLists.txt. |
| 60 | |
| Daniel Dunbar | 02271a7 | 2011-11-03 22:46:19 +0000 | [diff] [blame] | 61 | =item B<--write-make-fragment> |
| 62 | |
| 63 | Write out the LLVMBuild in the form of a Makefile fragment, so it can easily be |
| 64 | consumed by a Make based build system. The exact contents and format of this |
| 65 | file are closely tied to how LLVMBuild is integrated with the Makefiles, see |
| 66 | LLVM's Makefile.rules. |
| 67 | |
| Daniel Dunbar | 2adb2a5 | 2011-11-03 17:56:24 +0000 | [diff] [blame] | 68 | =item B<--llvmbuild-source-root>=I<PATH> |
| 69 | |
| 70 | If given, expect the I<LLVMBuild> files for the project to be rooted at the |
| 71 | given path, instead of inside the source tree itself. This option is primarily |
| 72 | designed for use in conjunction with B<--write-llvmbuild> to test changes to |
| 73 | I<LLVMBuild> schema. |
| 74 | |
| 75 | =back |
| 76 | |
| 77 | =head1 EXIT STATUS |
| 78 | |
| 79 | B<llvm-build> exits with 0 if operation was successful. Otherwise, it will exist |
| 80 | with a non-zero value. |
| 81 | |
| 82 | =head1 AUTHOR |
| 83 | |
| 84 | Maintained by the LLVM Team (L<http://llvm.org/>). |
| 85 | |
| 86 | =cut |