diff options
author | David Chen <dzc@google.com> | 2016-07-26 20:54:03 +0000 |
---|---|---|
committer | Damien Martin-Guillerez <dmarting@google.com> | 2016-07-27 11:15:14 +0000 |
commit | 3e8bcae69a0718cf6972be086706b1841e0ed6b7 (patch) | |
tree | ce6b37e16350f164d9ef937a69ba51558c99e53d /site/docs/install.md | |
parent | 3b47b1fdc6b24bb2c947d02316c1cf4e6a02cf09 (diff) |
Move Bazel docs into versioned directory.
* Move all Bazel docs (excluding main page, search page, and blog)
into versions/master directory.
* Replace all original pages with redirects.
* Add Jekyll config with default_version setting to specify the default
version to redirect docs to.
* Add Jekyll config with version_prefix setting specific to pages under
each version directory.
* Update layouts to generate links to pages for the same version with the
version_prefix.
* Update Blaze release script to copy docs from
third_party/bazel/site/versions/master
Changes to follow this CL:
* Separate navigation from layouts so that navigation can be versioned
as well.
* Add tool for cutting a release of Bazel docs and copies them into a new
version directory.
Bug: #579
--
MOS_MIGRATED_REVID=128510319
Diffstat (limited to 'site/docs/install.md')
-rw-r--r-- | site/docs/install.md | 278 |
1 files changed, 2 insertions, 276 deletions
diff --git a/site/docs/install.md b/site/docs/install.md index 206226f282..1166fe133c 100644 --- a/site/docs/install.md +++ b/site/docs/install.md @@ -1,278 +1,4 @@ --- -layout: documentation -title: Installing Bazel +layout: redirect +redirect: docs/install.html --- - -# Installing Bazel - -Supported platforms: - -* [Ubuntu Linux (Wily 15.10 and Trusty 14.04 LTS)](#ubuntu) -* [Mac OS X](#mac-os-x) -* [Windows (highly experimental)](windows.md) - -For other platforms, you can try to [compile from source](#compiling-from-source). - -Required Java version: - -* Java JDK 8 or later ([JDK 7](#jdk7) is still supported - but deprecated). - -Extras: - -* [Bash completion](#bash) -* [zsh completion](#zsh) - -For more information on using Bazel, see [Getting -started](getting-started.html). - - -## <a name="ubuntu"></a>Ubuntu - -Install Bazel on Ubuntu using one of the following methods: - - * [Using our custom APT repostiory](#install-on-ubuntu) - * [Using binary installer](#install-with-installer-ubuntu) - * [Compiling Bazel from source](#compiling-from-source) - -### <a name="install-on-ubuntu"></a> Using Bazel custom API repository (recommended) - -#### 1. Install JDK 8 - -If you are running **Ubuntu Wily (15.10)**, you can skip this step. -But for **Ubuntu Trusty (14.04 LTS)** users, since OpenJDK 8 is not available on Trusty, please install Oracle JDK 8: - -``` -$ sudo add-apt-repository ppa:webupd8team/java -$ sudo apt-get update -$ sudo apt-get install oracle-java8-installer -``` - -Note: You might need to `sudo apt-get install software-properties-common` if you don't have the `add-apt-repository` command. See [here](http://manpages.ubuntu.com/manpages/wily/man1/add-apt-repository.1.html). - -#### 2. Add Bazel distribution URI as a package source (one time setup) - -``` -$ echo "deb [arch=amd64] http://storage.googleapis.com/bazel-apt stable jdk1.8" | sudo tee /etc/apt/sources.list.d/bazel.list -$ curl https://storage.googleapis.com/bazel-apt/doc/apt-key.pub.gpg | sudo apt-key add - -``` - -If you want to use the JDK 7, please replace `jdk1.8` with `jdk1.7` and if you want to install the testing version of Bazel, replace `stable` with `testing`. - -#### 3. Update and install Bazel - -`$ sudo apt-get update && sudo apt-get install bazel` - -Once installed, you can upgrade to newer version of Bazel with: - -`$ sudo apt-get upgrade bazel` - -### <a name="install-with-installer-ubuntu"></a>Install with Installer - -We provide binary installers on our -<a href="https://github.com/bazelbuild/bazel/releases">GitHub releases page</a> - -The installer only contains Bazel binary, some additional libraries are required to be installed on the machine to work. - - -#### 1. Install JDK 8 - -**Ubuntu Trusty (14.04 LTS).** OpenJDK 8 is not available on Trusty. To -install Oracle JDK 8: - -``` -$ sudo add-apt-repository ppa:webupd8team/java -$ sudo apt-get update -$ sudo apt-get install oracle-java8-installer -``` - -Note: You might need to `sudo apt-get install software-properties-common` if you don't have the `add-apt-repository` command. See [here](http://manpages.ubuntu.com/manpages/wily/man1/add-apt-repository.1.html). - -**Ubuntu Wily (15.10).** To install OpenJDK 8: - -``` -$ sudo apt-get install openjdk-8-jdk -``` - -#### 2. Install other required packages - -``` -$ sudo apt-get install pkg-config zip g++ zlib1g-dev unzip -``` - -#### 3. Download Bazel - -Download the [Bazel installer](https://github.com/bazelbuild/bazel/releases) for -your operating system. - -#### 4. Run the installer - -Run the installer: - -<pre> -$ chmod +x bazel-<em>version</em>-installer-<em>os</em>.sh -$ ./bazel-<em>version</em>-installer-<em>os</em>.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. - -#### 5. 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. - - - -## <a name="mac-os-x"></a>Mac OS X - -Install Bazel on Mac OS X using one of the following methods: - - * [Using Homebrew](#install-on-mac-os-x-homebrew) - * [Using binary installer](#install-with-installer-mac-os-x) - * [Compiling Bazel from source](#compiling-from-source) - - -### <a name="install-on-mac-os-x-homebrew"></a>Using Homebrew - -#### 1. Install Homebrew on Mac OS X (one time setup) - -`$ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"` - -#### 2. Install Bazel Homebrew Package - -`$ brew install bazel` - -Once installed, you can upgrade to newer version of Bazel with: - -`$ brew upgrade bazel` - - -### <a name="install-with-installer-mac-os-x"></a>Install with installer - -We provide binary installers on our -<a href="https://github.com/bazelbuild/bazel/releases">GitHub releases page</a> - -The installer only contains Bazel binary, some additional libraries are required to be installed on the machine to work. - -#### 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 x64" under "Java SE Development Kit". This will download a -DMG image with an install wizard. - -#### 2. Install XCode command line tools - -Xcode can be downloaded from the -[Apple Developer Site](https://developer.apple.com/xcode/downloads/), which will -redirect to the 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 -``` - -#### 3. Download Bazel - -Download the [Bazel installer](https://github.com/bazelbuild/bazel/releases) for -your operating system. - -#### 4. Run the installer - -Run the installer: - -<pre> -$ chmod +x bazel-<em>version</em>-installer-<em>os</em>.sh -$ ./bazel-<em>version</em>-installer-<em>os</em>.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. - -#### 5. 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. - -## <a name="compiling-from-source"></a>Compiling from source - -If you would like to build Bazel from source, clone the source from GitHub and -run `./compile.sh` to build it: - -``` -$ git clone https://github.com/bazelbuild/bazel.git -$ cd bazel -$ ./compile.sh -``` - -This will create a bazel binary in `bazel-bin/src/bazel`. This binary is -self-contained, so it can be copied to a directory on the PATH (e.g., -`/usr/local/bin`) or used in-place. - -Check our [continuous integration](http://ci.bazel.io) for the current status of -the build. - - -## <a name="jdk7"></a>Using Bazel with JDK 7 (deprecated) - -Bazel version _0.1.0_ runs without any change with JDK 7. However, future -version will stop supporting JDK 7 when our CI cannot build for it anymore. -The installer for JDK 7 for Bazel versions after _0.1.0_ is labeled -<pre> -./bazel-<em>version</em>-jdk7-installer-<em>os</em>.sh -</pre> -If you wish to use JDK 7, follow the same steps as for JDK 8 but with the _jdk7_ installer or using a different APT repository as described [here](#1-add-bazel-distribution-uri-as-a-package-source-one-time-setup). - -## <a name="bash"></a>Getting bash completion - -Bazel comes with a bash completion script. To install it: - -1. Build it with Bazel: `bazel build //scripts:bazel-complete.bash`. -2. Copy the script `bazel-bin/scripts/bazel-complete.bash` to your - completion folder (`/etc/bash_completion.d` directory under Ubuntu). - If you don't have a completion folder, you can copy it wherever suits - you and simply insert `source /path/to/bazel-complete.bash` in your - `~/.bashrc` file (under OS X, put it in your `~/.bash_profile` file). - -## <a name="zsh"></a>Getting zsh completion - -Bazel also comes with a zsh completion script. To install it: - -1. Add this script to a directory on your $fpath: - - ``` - fpath[1,0]=~/.zsh/completion/ - mkdir -p ~/.zsh/completion/ - cp scripts/zsh_completion/_bazel ~/.zsh/completion - ``` - -2. Optionally, add the following to your .zshrc. - - ``` - # This way the completion script does not have to parse Bazel's options - # repeatedly. The directory in cache-path must be created manually. - zstyle ':completion:*' use-cache on - zstyle ':completion:*' cache-path ~/.zsh/cache - ``` |