From 7ac22bd81ad20f7d3c558b03aeff239e45998180 Mon Sep 17 00:00:00 2001 From: Nathan Chancellor Date: Wed, 25 Mar 2020 14:42:34 -0700 Subject: [PATCH] README: Document manual LLVM source management Users can manually manage LLVM's source if they need to, either due to space/time requirements or doing things like bisection. Document this. Closes: #75 Signed-off-by: Nathan Chancellor --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c257c00d..3779364a 100644 --- a/README.md +++ b/README.md @@ -87,7 +87,11 @@ Python 3.5.3+ is recommended, as that is what the script has been tested against ## build-llvm.py -By default, `./build-llvm.py` will clone LLVM, grab the latest binutils tarball (for the LLVMgold.so plugin), and build LLVM, clang, and lld, and install them into `install`. Run `./build-llvm.py -h` for more options. +By default, `./build-llvm.py` will clone LLVM, grab the latest binutils tarball (for the LLVMgold.so plugin), and build LLVM, clang, and lld, and install them into `install`. + +The script automatically clones and manages the [`llvm-project`](https://github.com/llvm/llvm-project). If you would like to do this management yourself, such as downloading a release tarball from [releases.llvm.org](https://releases.llvm.org/), doing a more aggressive shallow clone (versus what is done in the script via `--shallow-clone`), or doing a bisection of LLVM, you just need to make sure that your source is in an `llvm-project` folder within the root of this repository and pass `--no-update` into the script. + +Run `./build-llvm.py -h` for more options and information. ## build-binutils.py