aboutsummaryrefslogtreecommitdiffhomepage
path: root/site
diff options
context:
space:
mode:
authorGravatar Laszlo Csomor <laszlocsomor@google.com>2018-05-14 01:58:00 -0700
committerGravatar Copybara-Service <copybara-piper@google.com>2018-05-14 01:59:19 -0700
commit4691ad917bd12457ef8276f05c72d629c523cd9a (patch)
treea4fa7029db4e82d2f041eb2e098cdbc1cc4c1ac5 /site
parent849df36c5ad31ebe8791c4228321c38c6d0ae56c (diff)
docs: fix formatting errors
Change-Id: Id881cc4381fcd355a3b4a65d9089072e4818aa16 Closes #5159. Change-Id: If14c9a2e55192f5ee5ab384fad27275a24ec12b1 PiperOrigin-RevId: 196472499
Diffstat (limited to 'site')
-rw-r--r--site/docs/install-compile-source.md57
-rw-r--r--site/docs/install-windows.md11
2 files changed, 35 insertions, 33 deletions
diff --git a/site/docs/install-compile-source.md b/site/docs/install-compile-source.md
index 8bdb85a4be..b602f11c32 100644
--- a/site/docs/install-compile-source.md
+++ b/site/docs/install-compile-source.md
@@ -9,21 +9,30 @@ You can build Bazel from source without using an existing Bazel binary.
### 1. Install the prerequisites
-#### Debian-based Unix systems
+#### Unix-like systems
+
+Ensure you have installed:
+
+* **Bash**
-To compile Bazel on Debian-based systems such as Ubuntu or Debian, ensure that
-JDK 8, Python, bash, zip, and the usual C++ build toolchain components are
-installed on your system.
+* **zip, unzip**
-For example, you can install them using the following command:
+* **C++ build toolchain**
+
+* **JDK 8.** You must install version 8 of the JDK. Versions other than 8 are
+ *not* supported.
+
+* **Python**. Versions 2 and 3 are supported.
+
+For example on Ubuntu Linux you can install these requirements using the following command:
```sh
-sudo apt-get install build-essential openjdk-8-jdk python zip
+sudo apt-get install build-essential openjdk-8-jdk python zip unzip
```
#### Windows
-To compile Bazel on Windows, install the following supporting software:
+Ensure you have installed:
* [MSYS2 shell](https://msys2.github.io/)
@@ -41,10 +50,10 @@ To compile Bazel on Windows, install the following supporting software:
*not* supported.
* **Python**. Versions 2 and 3 are supported. You *must* install the
- Windows-native version (downloadable from https://www.python.org). Versions
- installed via pacman in MSYS2 will not work.
+ Windows-native version (downloadable from [https://www.python.org](https://www.python.org)).
+ Versions installed via pacman in MSYS2 will not work.
-### 2. Download and unpack Bazel's distribution archive.
+### 2. Download and unpack Bazel's distribution archive
Download `bazel-<version>-dist.zip` from the [release page](https://github.com/bazelbuild/bazel/releases).
@@ -58,7 +67,7 @@ The distribution archive contains generated files in addition to the versioned s
#### Unix-like systems
-On Unix-like systems such as Ubuntu or macOS, do the following:
+On Unix-like systems such as Ubuntu Linux or macOS, do the following:
1. Open a shell or Terminal window.
@@ -75,37 +84,31 @@ Bazel binary, without an embedded JDK. You can copy it to a directory in the
1. Open the MSYS2 shell.
2. Set the following environment variables:
-
* `BAZEL_VS` or `BAZEL_VC`: Set to the path to the Visual Studio directory
or to the Visual C++ directory, respectively. Setting one of them is
enough.
-
* `BAZEL_SH`: Set to the path of the MSYS2 `bash.exe`.
Do not set this to `C:\Windows\System32\bash.exe`. (You have that file
if you installed Windows Subsystem for Linux.) Bazel does not support
this version of `bash.exe`.
-
* `PATH`: Add the Python directory.
-
* `JAVA_HOME`: Set to the JDK directory.
For example:
- ```sh
- export BAZEL_VS="C:/Program Files (x86)/Microsoft Visual Studio/2017/BuildTools"
- export BAZEL_SH="C:/msys64/usr/bin/bash.exe"
- export PATH="/c/python27:$PATH"
- export JAVA_HOME="C:/Program Files/Java/jdk1.8.0_112"
- ```
+
+ export BAZEL_VS="C:/Program Files (x86)/Microsoft Visual Studio/2017/BuildTools"
+ export BAZEL_SH="C:/msys64/usr/bin/bash.exe"
+ export PATH="/c/python27:$PATH"
+ export JAVA_HOME="C:/Program Files/Java/jdk1.8.0_112"
+
or
- ```sh
- export BAZEL_VC="C:/Program Files (x86)/Microsoft Visual Studio/2017/BuildTools/VC"
- export BAZEL_SH="c:/msys64/usr/bin/bash.exe"
- export PATH="/c/python27:$PATH"
- export JAVA_HOME="C:/Program Files/Java/jdk1.8.0_112"
- ```
+ export BAZEL_VC="C:/Program Files (x86)/Microsoft Visual Studio/2017/BuildTools/VC"
+ export BAZEL_SH="c:/msys64/usr/bin/bash.exe"
+ export PATH="/c/python27:$PATH"
+ export JAVA_HOME="C:/Program Files/Java/jdk1.8.0_112"
3. Change into the directory where you unpacked the distribution archive.
diff --git a/site/docs/install-windows.md b/site/docs/install-windows.md
index ca8f1bd47a..e738860805 100644
--- a/site/docs/install-windows.md
+++ b/site/docs/install-windows.md
@@ -29,14 +29,15 @@ typing `bazel` in any directory, without typing out the full path.
to download Bazel without an embedded JDK, look for `bazel-<version>-without-jdk-windows-x86_64.exe`
on the release page. To use it, you must install JDK 8 separately (older or newer versions are not
supported), and set the `JAVA_HOME` environment variable, e.g.:
-```
-set JAVA_HOME=c:\Program Files\Java\jdk1.8.0_171
-```
+
+ set JAVA_HOME=c:\Program Files\Java\jdk1.8.0_171
+
Pay attention not to use quotes (") around the path (like you would on Unixes).
### Other ways to get Bazel
You can also get Bazel by:
+
* [Installing Bazel using Chocolatey](#install-using-chocolatey)
* [Compiling Bazel from source](install-compile-source.html)
@@ -45,9 +46,7 @@ You can also get Bazel by:
You can install the Bazel package using the [Chocolatey](https://chocolatey.org)
package manager:
-```sh
-choco install bazel
-```
+ choco install bazel
This command will install the latest available version of Bazel and
its dependencies, such as the MSYS2 shell. This will not install Visual C++