blob: b1cb7de965c21e5fb1c56412bef1dad71b00ad61 [file] [log] [blame]
Renato Golin94cc1042016-04-26 11:02:23 +01001LLVM Development Helper Scripts
2===============================
3
4These scripts are meant to help you setup and develop around LLVM and its
5sub-projects. There are many perks when developing with LLVM, but the scripts
6can only cover part of them, while others have to be explained via documents.
7
8The directory is split in multiple parts:
9
10Bisect: Scripts to help you bisect a problem in LLVM. They use SVN on both
11LLVM and Clang and can spot errors at build, check-all and test-suite time. Due
12to the symlink problem, neither git nor svn bisect scripts work well with LLVM.
13
14Buildbot: Scripts for setting up a buildmaster and buildslaves and
15how to manage them in the long run.
16
17Helpers: Scripts that setup the Git/Svn repositories, check-out, validate
18branches, build and test LLVM in its multiple forms. Since the repositories have
19an intricate relationship (symlinks inside the llvm tree), dealing with them is
20not part of the scripts, and they assume the setup is conciously correct.
21
22Monitor: Scripts to help you monitor buildbots.
23
24Release: A simple wrapper around the test-release.sh script that records how
25we release for ARM and AArch64.
26
27Stress: A stress script that just builds LLVM non-stop. This is used to test
28experimental hardware for constant prolongued abuse of CPU, memory and disk
29resources.
30
31Test-suite: These scripts prepare and run the LNT test-suite in multiple ways.
32
33These scripts are not meant to be perfect, nor universal. You may find that only
34part of them are useful to you.