Remove leading '$' from docs that are interfering with copy/paste
Fixes: https://github.com/bazelbuild/bazel/issues/2399
Change-Id: I21d00430cdf7ece72f532a1cb1be94e9b07a0114
PiperOrigin-RevId: 152001779
diff --git a/site/contributing.md b/site/contributing.md
index 4271808..922989a 100644
--- a/site/contributing.md
+++ b/site/contributing.md
@@ -25,7 +25,7 @@
<li>Prepare a git commit that implements the feature. Don't forget to add tests.
<li>Create a new code review on <a href="https://bazel-review.googlesource.com">Gerrit</a>
by running:
- <pre>$ git push https://bazel.googlesource.com/bazel HEAD:refs/for/master</pre>
+ <pre>git push https://bazel.googlesource.com/bazel HEAD:refs/for/master</pre>
Gerrit upload requires that you:
<ul>
<li>Have signed a
diff --git a/site/versions/master/docs/getting-started.md b/site/versions/master/docs/getting-started.md
index 3f39f43..5c88c69 100644
--- a/site/versions/master/docs/getting-started.md
+++ b/site/versions/master/docs/getting-started.md
@@ -23,7 +23,7 @@
One workspace can be shared among multiple projects if desired.
```bash
-$ touch WORKSPACE
+touch WORKSPACE
```
## Creating a Build File
diff --git a/site/versions/master/docs/install-os-x.md b/site/versions/master/docs/install-os-x.md
index 32fff7d..a41a00f 100644
--- a/site/versions/master/docs/install-os-x.md
+++ b/site/versions/master/docs/install-os-x.md
@@ -29,12 +29,16 @@
Installing Homebrew is a one-time setup:
-`$ /usr/bin/ruby -e "$(curl -fsSL
-https://raw.githubusercontent.com/Homebrew/install/master/install)"`
+```bash
+/usr/bin/ruby -e "$(curl -fsSL
+https://raw.githubusercontent.com/Homebrew/install/master/install)"
+```
### 3. Install Bazel Homebrew Package
-`$ brew install bazel`
+```bash
+brew install bazel
+```
You are all set. You can confirm Bazel is installed successfully by running
`bazel version`.
@@ -69,7 +73,7 @@
command:
```
-$ sudo gcc --version
+sudo gcc --version
```
### 3. Download Bazel
@@ -82,8 +86,8 @@
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
+chmod +x bazel-<version>-installer-<os>.sh
+./bazel-<version>-installer-<os>.sh --user
</pre>
The `--user` flag installs Bazel to the `$HOME/bin` directory on your system and
@@ -97,10 +101,12 @@
this directory to your default paths, as follows:
```bash
-$ export PATH="$PATH:$HOME/bin"
+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
-`bazel version`.
+```bash
+bazel version
+```
diff --git a/site/versions/master/docs/install-ubuntu.md b/site/versions/master/docs/install-ubuntu.md
index 1c53104..c39b6b1 100644
--- a/site/versions/master/docs/install-ubuntu.md
+++ b/site/versions/master/docs/install-ubuntu.md
@@ -27,8 +27,8 @@
### 1. 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://bazel.build/bazel-release.pub.gpg | sudo apt-key add -
+echo "deb [arch=amd64] http://storage.googleapis.com/bazel-apt stable jdk1.8" | sudo tee /etc/apt/sources.list.d/bazel.list
+curl https://bazel.build/bazel-release.pub.gpg | sudo apt-key add -
```
If you want to use the JDK 7, please replace `jdk1.8` with `jdk1.7` and if you
@@ -36,11 +36,15 @@
### 2. Install and update Bazel
-`$ sudo apt-get update && sudo apt-get install bazel`
+```bash
+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`
+```bash
+sudo apt-get upgrade bazel
+```
## <a name="install-with-installer-ubuntu"></a>Install with installer
@@ -55,13 +59,13 @@
To install OpenJDK 8:
```
-$ sudo apt-get install openjdk-8-jdk
+sudo apt-get install openjdk-8-jdk
```
### 2. Install other required packages
```
-$ sudo apt-get install pkg-config zip g++ zlib1g-dev unzip
+sudo apt-get install pkg-config zip g++ zlib1g-dev unzip
```
### 3. Download Bazel
@@ -73,10 +77,10 @@
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>
+```bash
+chmod +x bazel-<version>-installer-<os>.sh
+./bazel-<version>-installer-<os>.sh --user
+```
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
@@ -89,7 +93,7 @@
this directory to your default paths, as follows:
```bash
-$ export PATH="$PATH:$HOME/bin"
+export PATH="$PATH:$HOME/bin"
```
You can also add this command to your `~/.bashrc` file.
diff --git a/site/versions/master/docs/query.html b/site/versions/master/docs/query.html
index c3802b4..dbe80e4 100644
--- a/site/versions/master/docs/query.html
+++ b/site/versions/master/docs/query.html
@@ -105,7 +105,7 @@
Note that this quoting is in addition to any quoting that may
be required by your shell. e.g.
</p>
- <pre>% bazel query ' "//foo:bar=wiz" ' # single-quotes for shell, double-quotes for Bazel.</pre>
+ <pre>bazel query ' "//foo:bar=wiz" ' # single-quotes for shell, double-quotes for Bazel.</pre>
<p>
Keywords, when quoted, are treated as ordinary words, thus
@@ -463,8 +463,8 @@
further processing. For example:
</p>
<pre>
- % bazel query deps(//my:target) --output=label | grep ... | sed ... | awk ... > foo
- % bazel query "kind(cc_binary, set($(<foo)))"
+ bazel query deps(//my:target) --output=label | grep ... | sed ... | awk ... > foo
+ bazel query "kind(cc_binary, set($(<foo)))"
</pre>
<p>
In the next example, <code>kind(cc_library,
@@ -473,9 +473,9 @@
an <code>awk</code> program.
</p>
<pre>
- % bazel query 'deps(//some_dir/foo:main)' --output maxrank |
+ bazel query 'deps(//some_dir/foo:main)' --output maxrank |
awk '($1 < 5) { print $2;} ' > foo
- % bazel query "kind(cc_library, set($(<foo)))"
+ bazel query "kind(cc_library, set($(<foo)))"
</pre>
<p>
In these examples, <code>$(<foo)</code> is a shorthand
@@ -1409,11 +1409,11 @@
<p>
<pre>
- $ # Querying over all members of //external returns the repository.
- $ bazel query 'kind(maven_jar, //external:*)'
+ # Querying over all members of //external returns the repository.
+ bazel query 'kind(maven_jar, //external:*)'
//external:other-repo
- $ # ...but the repository is not a dependency.
- $ bazel query 'kind(maven_jar, deps(//foo:bar))'
+ # ...but the repository is not a dependency.
+ bazel query 'kind(maven_jar, deps(//foo:bar))'
INFO: Empty results
</pre>
diff --git a/site/versions/master/docs/skylark/macros.md b/site/versions/master/docs/skylark/macros.md
index ba9c785..7782198 100644
--- a/site/versions/master/docs/skylark/macros.md
+++ b/site/versions/master/docs/skylark/macros.md
@@ -42,7 +42,10 @@
* You may filter the output based on `generator_function` (which function
generated the rules) or `generator_name` (the name attribute of the macro),
- e.g. `$ bazel query --output=build 'attr(generator_function, my_macro, //my/path:all)'`
+ e.g.
+ ```bash
+ $ bazel query --output=build 'attr(generator_function, my_macro, //my/path:all)'
+ ```
* To find out where exactly the rule `foo` is generated in a BUILD file, you
can try the following trick. Insert this line near the top of the BUILD
diff --git a/site/versions/master/docs/tutorial/android-app.md b/site/versions/master/docs/tutorial/android-app.md
index df69e25..f31736b 100644
--- a/site/versions/master/docs/tutorial/android-app.md
+++ b/site/versions/master/docs/tutorial/android-app.md
@@ -139,7 +139,7 @@
At a command-line prompt, open your new `BUILD` file for editing:
```bash
-$ vi $WORKSPACE/android/BUILD
+vi $WORKSPACE/android/BUILD
```
### Add an android_library rule
@@ -214,13 +214,13 @@
is inside your Bazel workspace:
```bash
-$ cd $WORKSPACE
+cd $WORKSPACE
```
Now, enter the following to build the sample app:
```bash
-$ bazel build //android:android
+bazel build //android:android
```
The [`build`](/docs/bazel-user-manual.html#build) subcommand instructs Bazel to
@@ -264,7 +264,7 @@
`android.apk` file:
```bash
-$ ls $WORKSPACE/bazel-bin/android
+ls $WORKSPACE/bazel-bin/android
```
## Run the app
@@ -281,7 +281,7 @@
Enter the following:
```bash
-$ bazel mobile-install //android:android
+bazel mobile-install //android:android
```
Note that the `mobile-install` subcommand also supports the
diff --git a/site/versions/master/docs/tutorial/backend-server.md b/site/versions/master/docs/tutorial/backend-server.md
index 5b91b44..00c61ac 100644
--- a/site/versions/master/docs/tutorial/backend-server.md
+++ b/site/versions/master/docs/tutorial/backend-server.md
@@ -99,7 +99,7 @@
Open your new `BUILD` file for editing:
```bash
-$ vi $WORKSPACE/backend/BUILD
+vi $WORKSPACE/backend/BUILD
```
### Add a java_binary rule
@@ -159,13 +159,13 @@
Make sure that your current working directory is inside your Bazel workspace:
```bash
-$ cd $WORKSPACE
+cd $WORKSPACE
```
Now, enter the following to build the sample app:
```bash
-$ bazel build //backend:backend
+bazel build //backend:backend
```
Bazel now launches and builds the sample app. During the build process, its
@@ -196,7 +196,7 @@
To run the application, enter the following:
```bash
-$ bazel-bin/backend/backend --port=12345
+bazel-bin/backend/backend --port=12345
```
Your application will be available at `http://localhost:12345`
@@ -213,13 +213,13 @@
Build the target that allows to deploy to App Engine:
```bash
-$ bazel build --java_toolchain=@io_bazel_rules_appengine//appengine:jdk7 //backend:backend.deploy
+bazel build --java_toolchain=@io_bazel_rules_appengine//appengine:jdk7 //backend:backend.deploy
```
Then, to deploy the application, enter the following:
```bash
-$ $WORKSPACE/bazel-bin/backend/backend.deploy <project-id>
+bazel-bin/backend/backend.deploy <project-id>
```
The deployment script prompts you to authorize access to Google Cloud Platform.
@@ -227,7 +227,7 @@
using the `bazel` command and the following rule target:
```bash
-$ bazel run //backend:backend.deploy <project-id>
+bazel run //backend:backend.deploy <project-id>
```
Your application URL will be `http://<project-id>.appspot.com`.
diff --git a/site/versions/master/docs/tutorial/cpp.md b/site/versions/master/docs/tutorial/cpp.md
index 3a0f3d1..cd18ce2 100644
--- a/site/versions/master/docs/tutorial/cpp.md
+++ b/site/versions/master/docs/tutorial/cpp.md
@@ -37,10 +37,11 @@
Using the following commands to create the necessary source files:
{% highlight bash %}
-$ # If you're not already there, move to your workspace directory.
-$ cd ~/gitroot/my-project
-$ mkdir ./main
-$ cat > main/hello-world.cc <<'EOF'
+# If you're not already there, move to your workspace directory.
+cd ~/gitroot/my-project
+mkdir ./main
+cat > main/hello-world.cc <<'EOF'
+
#include "lib/hello-greet.h"
#include "main/hello-time.h"
#include <iostream>
@@ -56,7 +57,9 @@
return 0;
}
EOF
-$ cat > main/hello-time.h <<'EOF'
+
+cat > main/hello-time.h <<'EOF'
+
#ifndef MAIN_HELLO_TIME_H_
#define MAIN_HELLO_TIME_H_
@@ -64,7 +67,9 @@
#endif
EOF
-$ cat > main/hello-time.cc <<'EOF'
+
+cat > main/hello-time.cc <<'EOF'
+
#include "main/hello-time.h"
#include <ctime>
#include <iostream>
@@ -74,8 +79,10 @@
std::cout << std::asctime(std::localtime(&result));
}
EOF
-$ mkdir ./lib
-$ cat > lib/hello-greet.h <<'EOF'
+
+mkdir ./lib
+cat > lib/hello-greet.h <<'EOF'
+
#ifndef LIB_HELLO_GREET_H_
#define LIB_HELLO_GREET_H_
@@ -85,7 +92,9 @@
#endif
EOF
-$ cat > lib/hello-greet.cc <<'EOF'
+
+cat > lib/hello-greet.cc <<'EOF'
+
#include "lib/hello-greet.h"
#include <string>
@@ -135,15 +144,36 @@
Now you are ready to build your hello world C++ binary:
{% highlight bash %}
-$ bazel build main:hello-world
+bazel build main:hello-world
+{% endhighlight %}
+
+This produces the following output:
+
+{% highlight bash %}
INFO: Found 1 target...
Target //main:hello-world up-to-date:
bazel-bin/main/hello-world
INFO: Elapsed time: 2.869s, Critical Path: 1.00s
-$ ./bazel-bin/main/hello-world
+{% endhighlight %}
+
+{% highlight bash %}
+./bazel-bin/main/hello-world
+{% endhighlight %}
+
+This produces the following output:
+
+{% highlight bash %}
Hello world
Thu Jun 23 18:51:46 2016
-$ ./bazel-bin/main/hello-world Bazel
+{% endhighlight %}
+
+{% highlight bash %}
+./bazel-bin/main/hello-world Bazel
+{% endhighlight %}
+
+This produces the following output:
+
+{% highlight bash %}
Hello Bazel
Thu Jun 23 18:52:10 2016
{% endhighlight %}
@@ -333,7 +363,12 @@
Now you can use `bazel test` to run the test.
{% highlight bash %}
-$ bazel test test:hello-test
+bazel test test:hello-test
+{% endhighlight %}
+
+This produces the following output:
+
+{% highlight bash %}
INFO: Found 1 test target...
Target //test:hello-test up-to-date:
bazel-bin/test/hello-test
diff --git a/site/versions/master/docs/tutorial/environment.md b/site/versions/master/docs/tutorial/environment.md
index 74ca13d..68548df 100644
--- a/site/versions/master/docs/tutorial/environment.md
+++ b/site/versions/master/docs/tutorial/environment.md
@@ -77,8 +77,8 @@
branch:
```bash
-$ cd $HOME
-$ git clone -b source-only https://github.com/bazelbuild/examples
+cd $HOME
+git clone -b source-only https://github.com/bazelbuild/examples
```
The `git clone` command creates a directory named `$HOME/examples/`. This
diff --git a/site/versions/master/docs/tutorial/ios-app.md b/site/versions/master/docs/tutorial/ios-app.md
index 55d3493..abf49d2 100644
--- a/site/versions/master/docs/tutorial/ios-app.md
+++ b/site/versions/master/docs/tutorial/ios-app.md
@@ -38,7 +38,7 @@
At a command-line prompt, open your new `BUILD` file for editing:
```bash
-$ vi $WORKSPACE/ios-app/BUILD
+vi $WORKSPACE/ios-app/BUILD
```
## Add an objc_library rule
@@ -117,13 +117,13 @@
Make sure that your current working directory is inside your Bazel workspace:
```bash
-$ cd $WORKSPACE
+cd $WORKSPACE
```
Now, enter the following to build the sample app:
```bash
-$ bazel build //ios-app:ios-app
+bazel build //ios-app:ios-app
```
Bazel now launches and builds the sample app. During the build process, its
@@ -176,7 +176,7 @@
Now you should be able to build the app for your device:
```bash
-$ bazel build //ios-app:ios-app --ios_multi_cpus=armv7,arm64
+bazel build //ios-app:ios-app --ios_multi_cpus=armv7,arm64
```
This will build the app "fat". If you would prefer just to build for
diff --git a/site/versions/master/docs/tutorial/java.md b/site/versions/master/docs/tutorial/java.md
index 83d2380..c117366 100644
--- a/site/versions/master/docs/tutorial/java.md
+++ b/site/versions/master/docs/tutorial/java.md
@@ -24,10 +24,10 @@
Use the following commands to make a small Java project for this example:
{% highlight bash %}
-$ # If you're not already there, move to your workspace directory.
-$ cd ~/gitroot/my-project
-$ mkdir -p src/main/java/com/example
-$ cat > src/main/java/com/example/ProjectRunner.java <<'EOF'
+# If you're not already there, move to your workspace directory.
+cd ~/gitroot/my-project
+mkdir -p src/main/java/com/example
+cat > src/main/java/com/example/ProjectRunner.java <<'EOF'
package com.example;
public class ProjectRunner {
@@ -36,7 +36,8 @@
}
}
EOF
-$ cat > src/main/java/com/example/Greeting.java <<'EOF'
+
+cat > src/main/java/com/example/Greeting.java <<'EOF'
package com.example;
public class Greeting {
@@ -70,14 +71,27 @@
Now you are ready to build your Java binary:
{% highlight bash %}
-$ cd ~/gitroot/my-project
-$ bazel build //:my-runner
+cd ~/gitroot/my-project
+bazel build //:my-runner
+{% endhighlight %}
+
+This produces the following output:
+
+{% highlight bash %}
INFO: Found 1 target...
Target //:my-runner up-to-date:
bazel-bin/my-runner.jar
bazel-bin/my-runner
INFO: Elapsed time: 1.021s, Critical Path: 0.83s
-$ bazel-bin/my-runner
+{% endhighlight %}
+
+{% highlight bash %}
+bazel-bin/my-runner
+{% endhighlight %}
+
+This produces the following output:
+
+{% highlight bash %}
Hi!
{% endhighlight %}
@@ -114,7 +128,12 @@
and running `//:my-other-runner`:
{% highlight bash %}
-$ bazel run //:my-other-runner
+bazel run //:my-other-runner
+{% endhighlight %}
+
+This produces the following output:
+
+{% highlight bash %}
INFO: Found 1 target...
Target //:my-other-runner up-to-date:
bazel-bin/my-other-runner.jar
@@ -137,8 +156,8 @@
file:
{% highlight bash %}
-$ mkdir -p src/main/java/com/example/cmdline
-$ cat > src/main/java/com/example/cmdline/Runner.java <<'EOF'
+mkdir -p src/main/java/com/example/cmdline
+cat > src/main/java/com/example/cmdline/Runner.java <<'EOF'
package com.example.cmdline;
import com.example.Greeting;
@@ -171,7 +190,12 @@
build `runner` we'll get a permissions error:
{% highlight bash %}
-$ bazel build //src/main/java/com/example/cmdline:runner
+bazel build //src/main/java/com/example/cmdline:runner
+{% endhighlight %}
+
+This produces the following output:
+
+{% highlight bash %}
ERROR: /home/user/gitroot/my-project/src/main/java/com/example/cmdline/BUILD:2:1:
Target '//:greeter' is not visible from target '//src/main/java/com/example/cmdline:runner'.
Check the visibility declaration of the former target if you think the dependency is legitimate.
@@ -196,7 +220,12 @@
run the `runner` binary:
{% highlight bash %}
-$ bazel run //src/main/java/com/example/cmdline:runner
+bazel run //src/main/java/com/example/cmdline:runner
+{% endhighlight %}
+
+This produces the following output:
+
+{% highlight bash %}
INFO: Found 1 target...
Target //src/main/java/com/example/cmdline:runner up-to-date:
bazel-bin/src/main/java/com/example/cmdline/runner.jar
@@ -217,7 +246,12 @@
only contains `Runner.class`, not its dependencies (`Greeting.class`):
{% highlight bash %}
-$ jar tf bazel-bin/src/main/java/com/example/cmdline/runner.jar
+jar tf bazel-bin/src/main/java/com/example/cmdline/runner.jar
+{% endhighlight %}
+
+This produces the following output:
+
+{% highlight bash %}
META-INF/
META-INF/MANIFEST.MF
com/
@@ -233,7 +267,12 @@
`<target-name>_deploy.jar`):
{% highlight bash %}
-$ bazel build //src/main/java/com/example/cmdline:runner_deploy.jar
+bazel build //src/main/java/com/example/cmdline:runner_deploy.jar
+{% endhighlight %}
+
+This produces the following output:
+
+{% highlight bash %}
INFO: Found 1 target...
Target //src/main/java/com/example/cmdline:runner_deploy.jar up-to-date:
bazel-bin/src/main/java/com/example/cmdline/runner_deploy.jar
diff --git a/site/versions/master/docs/tutorial/workspace.md b/site/versions/master/docs/tutorial/workspace.md
index ff3f6da..246ab4b 100644
--- a/site/versions/master/docs/tutorial/workspace.md
+++ b/site/versions/master/docs/tutorial/workspace.md
@@ -25,7 +25,7 @@
your workspace directory. At the command line, enter:
```bash
-$ export WORKSPACE=$HOME/examples/tutorial
+export WORKSPACE=$HOME/examples/tutorial
```
## Create a WORKSPACE file
@@ -42,7 +42,7 @@
Enter the following at the command line:
```bash
-$ touch $WORKSPACE/WORKSPACE
+touch $WORKSPACE/WORKSPACE
```
This creates the empty `WORKSPACE` file.
diff --git a/site/versions/master/docs/windows.md b/site/versions/master/docs/windows.md
index 86470f6..2f4fe0b 100644
--- a/site/versions/master/docs/windows.md
+++ b/site/versions/master/docs/windows.md
@@ -118,9 +118,9 @@
`--cpu=x64_windows_msvc` to enable it like this:
```bash
-$ bazel build --cpu=x64_windows_msvc examples/cpp:hello-world
-$ ./bazel-bin/examples/cpp/hello-world.exe
-$ bazel run --cpu=x64_windows_msvc examples/cpp:hello-world
+bazel build --cpu=x64_windows_msvc examples/cpp:hello-world
+./bazel-bin/examples/cpp/hello-world.exe
+bazel run --cpu=x64_windows_msvc examples/cpp:hello-world
```
### Build Java
@@ -129,9 +129,9 @@
Just try:
```bash
-$ bazel build examples/java-native/src/main/java/com/example/myproject:hello-world
-$ ./bazel-bin/examples/java-native/src/main/java/com/example/myproject/hello-world
-$ bazel run examples/java-native/src/main/java/com/example/myproject:hello-world
+bazel build examples/java-native/src/main/java/com/example/myproject:hello-world
+./bazel-bin/examples/java-native/src/main/java/com/example/myproject/hello-world
+bazel run examples/java-native/src/main/java/com/example/myproject:hello-world
```
### Build Python
@@ -141,8 +141,8 @@
See more details in this [design doc](/designs/2016/09/05/build-python-on-windows.html).
```bash
-$ bazel build examples/py_native:bin
-$ ./bazel-bin/examples/py_native/bin
-$ python ./bazel-bin/examples/py_native/bin # This works in both msys and cmd.exe
-$ bazel run examples/py_native:bin
+bazel build examples/py_native:bin
+./bazel-bin/examples/py_native/bin
+python ./bazel-bin/examples/py_native/bin # This works in both msys and cmd.exe
+bazel run examples/py_native:bin
```
