Skip to content

Commit

Permalink
README: Document manual LLVM source management
Browse files Browse the repository at this point in the history
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: ClangBuiltLinux#75
Signed-off-by: Nathan Chancellor <natechancellor@gmail.com>
  • Loading branch information
nathanchance committed Mar 25, 2020
1 parent b083773 commit 7ac22bd
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 7ac22bd

Please sign in to comment.