diff options
author | Serge <spomorski@google.com> | 2018-04-18 10:04:22 -0700 |
---|---|---|
committer | Copybara-Service <copybara-piper@google.com> | 2018-04-18 10:05:54 -0700 |
commit | 70e84f8926bd2cc38fea9e74af292d19038607b8 (patch) | |
tree | a548ada5b3ce92516e6afee14dbaeb05c6e81132 /site/docs/install-compile-source.md | |
parent | 9b72ae13744069a6dc5f8f474c7979a3b0c9200d (diff) |
Update macOS Install Instructions
Updating macOS install instructions together with David.
Closes #5025.
PiperOrigin-RevId: 193374002
Diffstat (limited to 'site/docs/install-compile-source.md')
-rw-r--r-- | site/docs/install-compile-source.md | 95 |
1 files changed, 51 insertions, 44 deletions
diff --git a/site/docs/install-compile-source.md b/site/docs/install-compile-source.md index 3bf6e7f2bf..31d63eddf2 100644 --- a/site/docs/install-compile-source.md +++ b/site/docs/install-compile-source.md @@ -8,47 +8,54 @@ title: Compiling Bazel from Source You can build Bazel from source without using an existing Bazel binary by doing the following: -1. Ensure that JDK 8, Python, Bash, zip, and the usual C++ build toolchain - are installed on your system. - * On systems based on Debian packages (Debian, Ubuntu): you can install - OpenJDK 8 and Python by running the following command in a terminal: - - ```sh - sudo apt-get install build-essential openjdk-8-jdk python zip - ``` - * On Windows: you need additional software and the right OS version. - See the [Windows page](windows.html). - -2. Download and unpack Bazel's distribution archive. - - Download `bazel-<version>-dist.zip` from the [release - page](https://github.com/bazelbuild/bazel/releases). - - **Note:** There is a **single, architecture-independent** distribution - archive. There are no architecture-specific or OS-specific distribution - archives. - - We recommend to also - verify the signature made by our [release - key](https://bazel.build/bazel-release.pub.gpg) 48457EE0. - - The distribution archive contains generated files in addition to the - versioned sources, so this step _cannot_ be short cut by checking out the - source tree. - -3. Build Bazel using `./compile.sh`. - * On Unix-like systems (e.g. Ubuntu, macOS), do the following steps in a - shell session: - 1. `cd` into the directory where you unpacked the distribution archive - 2. run `bash ./compile.sh` - * On Windows, do following steps in the MSYS2 shell: - 1. `cd` into the directory where you unpacked the distribution archive - 2. run `./compile.sh` - - Once you have a Bazel binary, you no longer need to use the MSYS2 shell. - You can run Bazel from the Command Prompt (`cmd.exe`) or PowerShell. - - The output will be `output/bazel` on Unix-like systems (e.g. Ubuntu, macOS) - and `output/bazel.exe` on Windows. This is a self-contained Bazel binary. - You can copy it to a directory on the `PATH` (such as `/usr/local/bin` on - Linux) or use it in-place. +### 1. Ensure that JDK 8, Python, Bash, zip, and the usual C++ build toolchain are installed on your system. + +* On systems based on Debian packages (Debian, Ubuntu): you can install +OpenJDK 8 and Python by running the following command in a terminal: + +```sh + sudo apt-get install build-essential openjdk-8-jdk python zip +``` +* On Windows: you need additional software and the right OS version. +See the [Windows page](windows.html). + +### 2. Download and unpack Bazel's distribution archive. + +Download `bazel-<version>-dist.zip` from the [release page](https://github.com/bazelbuild/bazel/releases). + +**Note:** There is a **single, architecture-independent** distribution archive. There are no architecture-specific or OS-specific distribution archives. + +We recommend to also verify the signature made by our [release key](https://bazel.build/bazel-release.pub.gpg) 48457EE0. + +The distribution archive contains generated files in addition to the versioned sources, so this step _cannot_ be short cut by checking out the source tree. + +### 3. Build Bazel using `./compile.sh`. +* On Unix-like systems (e.g. Ubuntu, macOS), do the following steps in a shell session: + 1. `cd` into the directory where you unpacked the distribution archive + 2. run `bash ./compile.sh` +* On Windows, do following steps in the MSYS2 shell: + 1. `cd` into the directory where you unpacked the distribution archive + 2. run `./compile.sh` + +Once you have a Bazel binary, you no longer need to use the MSYS2 shell. +You can run Bazel from the Command Prompt (`cmd.exe`) or PowerShell. + +The output will be `output/bazel` on Unix-like systems (e.g. Ubuntu, macOS) +and `output/bazel.exe` on Windows. This is a self-contained Bazel binary. +You can copy it to a directory on the `PATH` (such as `/usr/local/bin` on +Linux) or use it in-place. + +### (on Windows): set the `JAVA_HOME` environment variable to the JDK's directory. + +For example in the Windows Command Prompt (`cmd.exe`): + +``` +set JAVA_HOME=C:\Program Files\Java\jdk1.8.0_112 +``` + +**Note**: do not use quotes (") around the path like you would on Unix. +Windows doesn't need them and they may confuse Bazel. + +This step is not required if you downloaded a binary distribution of Bazel +or installed Bazel using Chocolatey. See [installing Bazel on +Windows](install-windows.html). |