aboutsummaryrefslogtreecommitdiffhomepage
path: root/site/docs/install-os-x.md
diff options
context:
space:
mode:
authorGravatar dzc <dzc@google.com>2017-05-31 20:37:50 +0200
committerGravatar László Csomor <laszlocsomor@google.com>2017-06-01 14:07:52 +0200
commit22b85a2a3c79c6f3aef1e0a61e485bb135be4551 (patch)
tree8235e8237b171ced2fa9f39f054f9a7d808c0771 /site/docs/install-os-x.md
parent40d64293b57f0d62bb15599c730f38484b91d3f0 (diff)
Restructure site/ directory into docs/ which only contains Bazel documentation.
The new docs/ directory in the bazel source tree will only contain the Bazel docs site, which is hosted at docs.bazel.build. This change deletes the marketing site and blog, which have been migrated to the bazel-website and bazel-blog GitHub repositories respectively. This change also updates the serve-docs.sh and ci/build.sh under scripts/ in preparation for publishing the docs site. Note that to help make reviews more manageable, this change is limited to moving files to their new locations. Here are the follow-up changes: * Update all links in docs to remove versions/master in paths and to add correct bazel.build subdomain when linking to pages on the marketing site or the blog. * Set up versioned directories on GCS bucket and add tooling for versioning docs This change is also coordinated with https://bazel-review.googlesource.com/c/11568/ to have the PublishSite job publish to docs.bazel.build rather than www.bazel.build. Issue #2397 RELNOTES: None PiperOrigin-RevId: 157612651
Diffstat (limited to 'site/docs/install-os-x.md')
-rw-r--r--site/docs/install-os-x.md130
1 files changed, 130 insertions, 0 deletions
diff --git a/site/docs/install-os-x.md b/site/docs/install-os-x.md
new file mode 100644
index 0000000000..249524b91e
--- /dev/null
+++ b/site/docs/install-os-x.md
@@ -0,0 +1,130 @@
+---
+layout: documentation
+title: Installing Bazel on macOS
+---
+
+# <a name="mac-os-x"></a>Install Bazel on macOS (OS X)
+
+> Note: Bazel release 0.5.0 contains a bug in the compiler detection on macOS which
+> requires Xcode and the iOS tooling to be installed
+> ([corresponding issue #3063](https://github.com/bazelbuild/bazel/issues/3063)).
+> If you had Command Line Tools installed, you also need to switch to Xcode using
+> `sudo xcode-select -s /Applications/Xcode.app/Contents/Developer`.
+
+Install Bazel on macOS (OS X) using one of the following methods:
+
+* [Use Homebrew (recommended)](#install-on-mac-os-x-homebrew)
+* [Use the binary installer](#install-with-installer-mac-os-x)
+* [Compile Bazel from source](install-compile-source.md)
+
+Bazel comes with two completion scripts. After installing Bazel, you can:
+
+* access the [bash completion script](install.md)
+* install the [zsh completion script](install.md)
+
+## <a name="install-on-mac-os-x-homebrew"></a>Install using Homebrew
+
+### 1. Install JDK 8
+
+JDK 8 can be downloaded from [Oracle's JDK
+Page](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html).
+
+Look for "Mac OS X" under "Java SE Development Kit". This will download a DMG
+image with an install wizard.
+
+### 2. Install Homebrew on macOS (OS X)
+
+Installing Homebrew is a one-time setup:
+
+```bash
+/usr/bin/ruby -e "$(curl -fsSL
+https://raw.githubusercontent.com/Homebrew/install/master/install)"
+```
+
+### 3. Install Bazel Homebrew Package
+
+```bash
+brew install bazel
+```
+
+You are all set. You can confirm Bazel is installed successfully by running
+`bazel version`.
+
+You can later upgrade to newer version of Bazel with `brew upgrade bazel`.
+
+## <a name="install-with-installer-mac-os-x"></a>Install using binary installer
+
+The binary installers are on Bazel's [GitHub releases page](https://github.com/bazelbuild/bazel/releases).
+
+The installer contains the Bazel binary and the required JDK. Some additional
+libraries must also be installed for Bazel to work.
+
+### 1. Install XCode command line tools
+
+Xcode can be downloaded from the [Apple Developer
+Site](https://developer.apple.com/xcode/downloads/) (this link redirects to
+their App Store).
+
+For `objc_*` and `ios_*` rule support, you must have Xcode 6.1 or later with iOS
+SDK 8.1 installed on your system.
+
+Once XCode is installed you can trigger signing the license with the following
+command:
+
+```
+sudo gcc --version
+```
+
+### 2. Download the Bazel installer
+
+Go to Bazel's [GitHub releases page](https://github.com/bazelbuild/bazel/releases).
+
+Download the binary installer `bazel-0.5.0-installer-darwin-x86_64.sh`. This
+installer contains the Bazel binary and the required JDK, and can be used even
+if a JDK is already installed.
+
+Note that `bazel-0.5.0-without-jdk-installer-darwin-x86_64.sh` is a version of
+the installer without embedded JDK 8. Only use this installer if you already
+have JDK 8 installed.
+
+Note that two other versions of the installer exist:
+* `bazel-0.5.0-without-jdk-installer-darwin-x86_64.sh`: version without
+ embedded JDK 8. Only use this installer if you already have JDK 8 installed.
+* `bazel-0.5.0-jdk7-installer-darwin-x86_64.sh`: last release compatible
+ with JDK 7.
+
+### 3. Run the installer
+
+Run the installer:
+
+<pre>
+chmod +x bazel-0.5.0-installer-darwin-x86_64.sh
+./bazel-0.5.0-installer-darwin-x86_64.sh --user
+</pre>
+
+The `--user` flag installs Bazel to the `$HOME/bin` directory on your system and
+sets the `.bazelrc` path to `$HOME/.bazelrc`. Use the `--help` command to see
+additional installation options.
+
+### 4. Set up your environment
+
+If you ran the Bazel installer with the `--user` flag as above, the Bazel
+executable is installed in your `$HOME/bin` directory. It's a good idea to add
+this directory to your default paths, as follows:
+
+```bash
+export PATH="$PATH:$HOME/bin"
+```
+
+You can also add this command to your `~/.bashrc` file.
+
+You are all set. You can confirm Bazel is installed successfully by running
+```bash
+bazel version
+```
+
+Once installed, you can upgrade to a newer version of Bazel with:
+
+```bash
+sudo apt-get upgrade bazel
+```