Skip to content

Commit

Permalink
Update links in Bazel docs to point to new BE pages.
Browse files Browse the repository at this point in the history
Fixes bazelbuild#529

--
MOS_MIGRATED_REVID=106883457
  • Loading branch information
davidzchen committed Nov 2, 2015
1 parent 06f65f7 commit c23d661
Show file tree
Hide file tree
Showing 16 changed files with 67 additions and 70 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Find more background about Bazel in our [FAQ](http://bazel.io/faq.html).
* How to [install Bazel](http://bazel.io/docs/install.html)
* How to [get started using Bazel](http://bazel.io/docs/getting-started.html)
* The Bazel command line is documented in the [user manual](http://bazel.io/docs/bazel-user-manual.html)
* The rule reference documentation is in the [build encyclopedia](http://bazel.io/docs/build-encyclopedia.html)
* The rule reference documentation is in the [build encyclopedia](http://bazel.io/docs/be/overview.html)
* How to [use the query command](http://bazel.io/docs/query.html)
* How to [extend Bazel](http://bazel.io/docs/skylark/index.html)
* The test environment is described in the [test encyclopedia](http://bazel.io/docs/test-encyclopedia.html)
Expand Down
2 changes: 1 addition & 1 deletion site/blog/_posts/2015-09-01-beta-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Our beta release provides:
* Binary releases for
[Linux and OS X](https://github.com/bazelbuild/bazel/releases).
* Support for building and testing C++, Java, Python, Rust,
[and more](http://bazel.io/docs/build-encyclopedia.html).
[and more](http://bazel.io/docs/be/overview.html).
* Support for building Docker images, Android apps, and iOS apps.
* Support for using libraries from
[Maven, GitHub, and more](http://bazel.io/docs/external.html).
Expand Down
22 changes: 11 additions & 11 deletions site/docs/bazel-user-manual.html
Original file line number Diff line number Diff line change
Expand Up @@ -1032,9 +1032,9 @@ <h4 id='flag--experimental_action_listener'>
</h4>
<p>
The <code>experimental_action_listener</code> option instructs Bazel to use
details from the <a href="build-encyclopedia.html#action_listener"
details from the <a href="be/extra-actions.html#action_listener"
><code>action_listener</code></a> rule specified by <var>label</var> to
insert <a href="build-encyclopedia.html#extra_action"
insert <a href="be/extra-actions.html#extra_action"
><code>extra_actions</code></a> into the build graph.
</p>

Expand Down Expand Up @@ -1212,7 +1212,7 @@ <h4 id='flag--linkopt'><code class='flag'>--linkopt <var>linker-option</var></co
<p>
Build rules can also specify link options in their attributes. This option's
settings always take precedence. Also see
<a href="build-encyclopedia.html#cc_library.linkopts">cc_library.linkopts</a>.
<a href="be/c-cpp.html#cc_library.linkopts">cc_library.linkopts</a>.
</p>

<h4 id='flag--strip'><code class='flag'>--strip (always|never|sometimes)</code></h4>
Expand Down Expand Up @@ -1246,7 +1246,7 @@ <h4 id='flag--strip'><code class='flag'>--strip (always|never|sometimes)</code><
<h4 id='flag--stripopt'><code class='flag'>--stripopt <var>strip-option</var></code></h4>
<p>
An additional option to pass to the <code>strip</code> command when generating
a <a href="build-encyclopedia.html#cc_binary_implicit_outputs"><code>*.stripped</code>
a <a href="be/c-cpp.html#cc_binary_implicit_outputs"><code>*.stripped</code>
binary</a>. The default is <code>-S -p</code>. This option can be used
multiple times.
</p>
Expand Down Expand Up @@ -1575,7 +1575,7 @@ <h4 id='flag--per_file_copt'><code class='flag'>--per_file_copt
<h4 id='flag--dynamic_mode'><code class='flag'>--dynamic_mode <var>mode</var></code></h4>
<p>
Determines whether C++ binaries will be linked dynamically, interacting with
the <a href='build-encyclopedia.html#cc_binary.linkstatic'>linkstatic
the <a href='be/c-cpp.html#cc_binary.linkstatic'>linkstatic
attribute</a> on build rules.
</p>

Expand All @@ -1586,14 +1586,14 @@ <h4 id='flag--dynamic_mode'><code class='flag'>--dynamic_mode <var>mode</var></c
<li><code>auto</code>: Translates to a platform-dependent mode;
<code>default</code> for linux and <code>off</code> for cygwin.</li>
<li><code>default</code>: Allows bazel to choose whether to link dynamically.
See <a href='build-encyclopedia.html#cc_binary.linkstatic'>linkstatic</a> for more
See <a href='be/c-cpp.html#cc_binary.linkstatic'>linkstatic</a> for more
information.</li>
<li><code>fully</code>: Links all targets dynamically. This will speed up
linking time, and reduce the size of the resulting binaries.

</li>
<li><code>off</code>: Links all targets in
<a href='build-encyclopedia.html#cc_binary.linkstatic'>mostly static</a> mode.
<a href='be/c-cpp.html#cc_binary.linkstatic'>mostly static</a> mode.
If <code>-static</code> is set in linkopts, targets will change to fully
static.</li>
</ul>
Expand Down Expand Up @@ -1705,7 +1705,7 @@ <h4 id='flag--javabase'><code class='flag'>--javabase (<var>path</var>|<var>labe
This options set the label or the path of the base Java installation to use
for running JavaBuilder, SingleJar, and is also used for bazel run and inside
Java binaries built by <code>java_binary</code> rules. The various
<a href='build-encyclopedia.html#make_variables'>"Make" variables</a> for
<a href='be/make-variables.html'>"Make" variables</a> for
Java (<code>JAVABASE</code>, <code>JAVA</code>, <code>JAVAC</code> and
<code>JAR</code>) are derived from this option.
</p>
Expand Down Expand Up @@ -2140,7 +2140,7 @@ <h4 id='flag--test_tag_filters'><code class='flag'>--test_tag_filters <var>tag[,
<h4 id='flag--test_lang_filters'><code class='flag'>--test_lang_filters <var>lang[,lang]*</var></code></h4>
<p>
Specifies a comma-separated list of test languages for languages with an official <code>*_test</code> rule the
(see <a href="build-encyclopedia.html">build encyclopedia</a> for a full list of these). Each
(see <a href="be/overview.html">build encyclopedia</a> for a full list of these). Each
language can be optionally preceded with '-' to specify excluded
languages. The name used for each language should be the same as
the language prefix in the <code>*_test</code> rule, for example,
Expand Down Expand Up @@ -2350,7 +2350,7 @@ <h4 id='flag--stamp'><code class='flag'>--[no]stamp</code></h4>
<p>
Stamping can be enabled or disabled explicitly in BUILD using
the <code>stamp</code> attribute of certain rule types, please refer to
the <a href="build-encyclopedia.html">build encyclopedia</a> for details. For
the <a href="be/overview.html">build encyclopedia</a> for details. For
rules that are neither explicitly or implicitly configured as <code>stamp =
0</code> or <code>stamp = 1</code>, the <code class='flag'>--[no]stamp</code> option
selects whether stamping is enabled. Bazel never stamps binaries that are
Expand Down Expand Up @@ -3046,7 +3046,7 @@ <h4>Configuration-specific data</h4>
</li>
<li>
The complete
<a href='build-encyclopedia.html#make_variables'
<a href='be/make-variables.html'
>"Make" environment</a>. If the <code class='flag'>--show_make_env</code> flag is
specified, all variables in the current configuration's "Make" environment
are also displayed (e.g. <code>CC</code>, <code>GLIBC_VERSION</code>, etc).
Expand Down
25 changes: 12 additions & 13 deletions site/docs/build-ref.html
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ <h3 id="targets">Targets</h3>
A package is a container. The elements of a package are called
<i>targets</i>. Most targets are one of two principal kinds, <i>files</i>
and <i>rules</i>. Additionally, there is another kind of target,
<a href="build-encyclopedia.html#package_group">package groups</a>,
<a href="be/functions.html#package_group">package groups</a>,
but they are far less numerous.
</p>

Expand Down Expand Up @@ -246,7 +246,7 @@ <h3 id="targets">Targets</h3>
<i>visibility</i> attribute of rules or from the <i>default_visibility</i>
attribute of the <i>package</i> function; they do not generate or consume
files. For more information, refer to the appropriate section of the
<a href='build-encyclopedia.html#package_group'>Build Encyclopedia</a>.
<a href='be/functions.html#package_group'>Build Encyclopedia</a>.
</p>


Expand Down Expand Up @@ -443,7 +443,7 @@ <h3 id="rules">Rules</h3>
kinds or <i>classes</i>, which produce compiled
executables and libraries, test executables and other supported
outputs as described in the
<a href="build-encyclopedia.html">Build Encyclopedia</a>.
<a href="be/overview.html">Build Encyclopedia</a>.
</p>

<p>
Expand All @@ -461,7 +461,7 @@ <h3 id="rules">Rules</h3>
Every rule has a set of <i>attributes</i>; the applicable attributes
for a given rule, and the significance and semantics of each
attribute are a function of the rule's class; see
the <a href='build-encyclopedia.html'>Build
the <a href='be/overview.html'>Build
Encyclopedia</a> for the full list of supported rules and their
corresponding attributes. Each attribute has a name and a
type. The full set of types that an attribute can have is: integer,
Expand Down Expand Up @@ -774,12 +774,11 @@ <h2 id="funcs">Types of build rule</h2>
libraries, and tests, respectively. Other languages use the same
naming scheme, with a different prefix, e.g. <code>java_*</code> for
Java. These functions are all documented in the
<a href="build-encyclopedia.html">Build Encyclopedia</a>.
<a href="be/overview.html">Build Encyclopedia</a>.
</p>

<ul>
<li><p>A <a href='build-encyclopedia.html#binary'><code>*_binary</code></a>

<li><p>A <code>*_binary</code>
rule builds an executable program in a given language. After a
build, the executable will reside in the build tool's binary
output tree at the corresponding name for the rule's label,
Expand All @@ -794,7 +793,7 @@ <h2 id="funcs">Types of build rule</h2>
one place for ease of deployment to production.</p>
</li>

<li><p>A <a href='build-encyclopedia.html#test'><code>*_test</code></a>
<li><p>A <code>*_test</code>
rule is a specialization of a *_binary rule, used for automated
testing. Tests are simply programs that return zero on success.

Expand All @@ -816,7 +815,7 @@ <h2 id="funcs">Types of build rule</h2>
</p>
</li>

<li>A <a href='build-encyclopedia.html#library'><code>*_library</code></a>
<li>A <code>*_library</code>
rule specifies a separately-compiled module in the given
programming language. Libraries can depend on other libraries,
and binaries and tests can depend on libraries, with the expected
Expand Down Expand Up @@ -1036,7 +1035,7 @@ <h3 id="types_of_dependencies">Types of dependencies</h3>
Most build rules have three attributes for specifying different kinds
of generic dependencies: <code>srcs</code>, <code>deps</code> and
<code>data</code>. These are explained below. See also
<a href='build-encyclopedia.html#common-attributes'>Attributes common
<a href='be/common-definitions.html'>Attributes common
to all rules</a> in the Build Encyclopedia.)
</p>

Expand Down Expand Up @@ -1136,8 +1135,8 @@ <h3 id="label_directory">Using Labels to Reference Directories</h3>
Rather than specifying directories as inputs to the build system,
you should enumerate the set of files contained within them, either
explicitly or using the
<a href='build-encyclopedia.html#glob'><code>glob()</code></a> function.
(Use <code>**</code> to force the <a href='build-encyclopedia.html#glob'>
<a href='be/functions.html#glob'><code>glob()</code></a> function.
(Use <code>**</code> to force the <a href='be/functions.html#glob'>
<code>glob()</code></a> to be recursive.)
</p>

Expand All @@ -1150,7 +1149,7 @@ <h3 id="label_directory">Using Labels to Reference Directories</h3>
names do not conform to the strict <a href='#lexi'>label syntax</a>
(e.g. they contain certain punctuation symbols), then explicit
enumeration of files, or use of the
<a href='build-encyclopedia.html#glob'><code>glob()</code></a> function will
<a href='be/functions.html#glob'><code>glob()</code></a> function will
produce an invalid labels error. You must use directory labels in this case,
but beware of the concomitant risk of incorrect rebuilds described above.
</p>
Expand Down
10 changes: 5 additions & 5 deletions site/docs/external.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ External dependencies can be specified in a `WORKSPACE` file in the
[workspace directory](/docs/build-ref.html#workspaces). This `WORKSPACE` file
uses the same Python-like syntax of BUILD files, but allows a different set of
rules. See the full list of rules that are allowed in the
[Workspace](/docs/build-encyclopedia.html#workspace) list of rules in the Build
[Workspace](/docs/be/workspace.html) list of rules in the Build
Encyclopedia.

## Fetching dependencies
Expand Down Expand Up @@ -99,8 +99,8 @@ There are a few basic types of external dependencies that can be created.

If you have a second Bazel project that you'd like to use targets from, you can
use
[`local_repository`](http://bazel.io/docs/build-encyclopedia.html#local_repository)
or [`http_archive`](http://bazel.io/docs/build-encyclopedia.html#http_archive)
[`local_repository`](http://bazel.io/docs/be/workspace.html#local_repository)
or [`http_archive`](http://bazel.io/docs/be/workspace.html#http_archive)
to symlink it from the local filesystem or download it (respectively).

For example, suppose you are working on a project, `my-project/`, and you want
Expand All @@ -122,8 +122,8 @@ If your coworker has a target `//foo:bar`, your project can refer to it as
## Depending on non-Bazel projects

Rules prefixed with `new_` (e.g.,
[`new_local_repository`](http://bazel.io/docs/build-encyclopedia.html#new_local_repository)
and [`new_http_archive`](http://bazel.io/docs/build-encyclopedia.html#new_http_archive)
[`new_local_repository`](http://bazel.io/docs/be/workspace.html#new_local_repository)
and [`new_http_archive`](http://bazel.io/docs/be/workspace.html#new_http_archive)
) allow you to create targets from projects that do not use Bazel.

For example, suppose you are working on a project, `my-project/`, and you want
Expand Down
6 changes: 3 additions & 3 deletions site/docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ identifier you'll use when you ask bazel to build the binary. `srcs` lists the
Java source files Bazel should compile into a Java binary.
`glob(["**/*.java"])` is a handy shorthand for "recursively include every file
that ends with .java" (see the
[build encyclopedia](build-encyclopedia.html#glob) for more information about
[build encyclopedia](be/functions.html#glob) for more information about
globbing). `com.example.ProjectRunner` specifies the class that contains the
main method.

Expand Down Expand Up @@ -221,7 +221,7 @@ INFO: Running command line: bazel-bin/src/main/java/com/example/cmdline/runner
Hi!
{% endhighlight %}

See the [build encyclopedia](build-encyclopedia.html#common.visibility) for more
See the [build encyclopedia](be/common-definitions.html#common.visibility) for more
visibility options.

## Deploying
Expand Down Expand Up @@ -261,7 +261,7 @@ INFO: Elapsed time: 1.700s, Critical Path: 0.23s
You can now create your own targets and compose them. Next, check out the
[tutorial](/docs/tutorial/index.html) to learn how to build a server backend,
Android app, and iOS app with Bazel. Also see the
[build encyclopedia](build-encyclopedia.html) and
[build encyclopedia](be/overview.html) and
[user manual](bazel-user-manual.html) for more information.
[Let us know](https://groups.google.com/forum/#!forum/bazel-discuss) if you have
any questions!
1 change: 1 addition & 0 deletions site/docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,7 @@ Bazel also comes with a zsh completion script. To install it:
zstyle ':completion:*' use-cache on
zstyle ':completion:*' cache-path ~/.zsh/cache
```
## Compiling from source
If you would like to build Bazel from source, clone the source from GitHub and
Expand Down
2 changes: 1 addition & 1 deletion site/docs/test-encyclopedia.html
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ <h3>Role of the Test Runner</h3>
tests whose specified size is too big.</p>

<p>Test sizes and timeouts are specified in the BUILD file according to the specification
<a href="build-encyclopedia.html#test">here</a>.
<a href="be/common-definitions.html#common-attributes-tests">here</a>.
Any test that does not specify a recognized size will default to being a medium
test.</p>

Expand Down
4 changes: 2 additions & 2 deletions site/docs/tutorial/android-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ files or other dependencies.

Bazel provides two build rules, `android_library` and `android_binary`, that you
can use to build an Android app. For this tutorial, you'll first use the
[`android_library`](/docs/build-encyclopedia.html#android_library) rule to tell
[`android_library`](/docs/be/android.html#android_library) rule to tell
Bazel how to build an
[Android library module](http://developer.android.com/tools/projects/index.html#LibraryProjects)
from the app source code and resource files. Then you'll use the
Expand All @@ -156,7 +156,7 @@ reference the rule using this name as a dependency in the `android_binary` rule.

### Add an android_binary rule

The [`android_binary`](/docs/build-encyclopedia.html#android_binary) rule builds
The [`android_binary`](/docs/be/android.html#android_binary) rule builds
the Android application package (`.apk` file) for your app.

Add the following to your build file:
Expand Down
19 changes: 9 additions & 10 deletions site/docs/tutorial/backend-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,7 @@ Here, you'll do the following:
* Deploy to a local development server
* Deploy to Google App Engine

Bazel provides a set of
[App Engine build rules](https://github.com/bazelbuild/bazel/blob/master/tools/build_rules/appengine/README.md)
Bazel provides a set of [App Engine build rules](/docs/be/appengine.html)
written using the [Skylark](/docs/skylark/index.html) framework. You'll use
these in the steps below to build the application.

Expand Down Expand Up @@ -60,7 +59,7 @@ backend server, however, you'll give Bazel instructions for downloading the
required App Engine SDK package from a remote server. This is optional. You
can also download and install the SDK manually on your filesystem and reference
it from that location as described in the
[App Engine rule documentation](https://github.com/google/bazel/blob/master/tools/build_rules/appengine/README.md).
[App Engine rule documentation](/docs/be/appengine.html).

Add the following to your `WORKSPACE` file:

Expand All @@ -73,15 +72,15 @@ new_http_archive(
)
```

The [`new_http_archive`](/docs/build-encyclopedia.html#new_http_archive) rule
The [`new_http_archive`](/docs/be/workspace.html#new_http_archive) rule
instructs Bazel to download a remote archive file, uncompress it and add it to
the virtual `external` package by combining the archive contents with
the referenced `BUILD` file, here `appengine.BUILD`. You'll create this file
below after you finish updating your `WORKSPACE` file.

### Add bind rules

You also need to add some [`bind`](docs/build-encyclopedia.html#bind) rules
You also need to add some [`bind`](/docs/be/workspace.html#bind) rules
to the file. These provide aliases to targets in the virtual `external` package
so they can be located either either inside or outside the workspace without
changing the App Engine build rules.
Expand All @@ -108,7 +107,7 @@ bind(
### Add maven_jar rules

Finally, you need to add some
[`maven_jar`](/docs/build-encyclopedia.html#maven_jar) rules to the file. These
[`maven_jar`](/docs/be/workspace.html#maven_jar) rules to the file. These
tell Bazel to download `.jar` files from the Maven repository and allow Bazel
to use them as Java dependencies.

Expand Down Expand Up @@ -173,7 +172,7 @@ filegroup(
)
```

The [`java_import`](/docs/build-encyclopedia.html#java_import) rules tell
The [`java_import`](/docs/be/java.html#java_import) rules tell
Bazel how to use the precompiled SDK `.jar` files as libraries. These rules
define the targets that you referenced in the `bind` rules in the `WORKSPACE`
file above.
Expand Down Expand Up @@ -209,11 +208,11 @@ java_binary(
)
```

The [`java_binary`](/docs/build-encyclopedia.html#java_binary) tells Bazel
The [`java_binary`](/docs/be/java.html#java_binary) tells Bazel
how to build a Java `.jar` library for your application, plus a wrapper shell
script that launches the application code from the specified main class. Here,
we're using this rule instead of the
[`java_library`](/docs/build-encyclopedia.html#java_library) because we need
[`java_library`](/docs/be/java.html#java_library) because we need
the `.jar` file to contain all the dependencies required to build the final
App Engine `.war` file. For this reason, we specify a bogus class name
for the `main_class` attribute.
Expand All @@ -236,7 +235,7 @@ filegroup(
)
```

The [`appengine_war`](https://github.com/google/bazel/blob/master/tools/build_rules/appengine/README.md)
The [`appengine_war`](/docs/be/appengine.html#appengine_war)
rule builds the final App Engine `war` file from the library `.jar` file and web
application metadata files in the `webapp` directory.

Expand Down
Loading

0 comments on commit c23d661

Please sign in to comment.