Google Git
Sign in
bazel / bazel / d96c908d71e2771f1e49c562835099a2fb9c9ef8 / . / site / _layouts / documentation.html
blob: 10f3b669432bd5eb213707dc4eafdb39f7484152 [file] [log] [blame]
David Chenbd690802016-04-26 07:12:42 +0000[diff] [blame]1---
2nav: docs
3---
4
5<!DOCTYPE html>
6<html lang="en" itemscope itemtype="https://schema.org/WebPage">
7 {% include head.html %}
8 <body>
9 {% include header.html %}
10
11 <div class="page-title-bar">
12 <div class="container">
13 <h1>Documentation</h1>
14 </div>
15 </div>
16
17 <div class="container vpad">
18 <div class="row">
Jingwen6060c792017-12-11 05:22:52 -0800[diff] [blame]19 <div class="col-md-3">
David Chenbd690802016-04-26 07:12:42 +0000[diff] [blame]20 <a class="btn btn-default btn-lg btn-block sidebar-toggle"
21 data-toggle="collapse" href="#sidebar-nav" aria-expanded="false"
22 aria-controls="sidebar-nav">
23 <i class="glyphicon glyphicon-menu-hamburger"></i> Navigation
24 </a>
25 <nav class="sidebar collapse" id="sidebar-nav">
spomorskicc16d4c2017-12-07 14:09:21 -0800[diff] [blame]26 <h3>Home</h3>
David Chenbd690802016-04-26 07:12:42 +0000[diff] [blame]27 <ul class="sidebar-nav">
dzc5596d3b2017-06-07 21:51:52 -0400[diff] [blame]28 <li><a href="/versions/{{ site.version }}/bazel-overview.html">Bazel Overview</a></li>
Dmitry Lomovedc33762018-07-23 06:37:58 -0700[diff] [blame]29 <li><a href="/versions/{{ site.version }}/bazel-vision.html">Bazel Vision</a></li>
laurentlbc7914152018-02-23 09:29:18 -0800[diff] [blame]30 <li><a href="/versions/{{ site.version }}/getting-started.html">Getting Started</a></li>
laurentlb0d978042018-09-26 05:32:17 -0700[diff] [blame]31 <li><a href="/versions/{{ site.version }}/skylark/backward-compatibility.html">Backward Compatibility</a></li>
Tobias Werth480ac152016-06-20 15:06:33 +0000[diff] [blame]32 </ul>
spomorskicc16d4c2017-12-07 14:09:21 -0800[diff] [blame]33
ahumesky71c14412017-12-08 11:55:53 -0800[diff] [blame]34 <h3>Using Bazel</h3>
David Chenbd690802016-04-26 07:12:42 +0000[diff] [blame]35 <ul class="sidebar-nav">
laurentlbc7914152018-02-23 09:29:18 -0800[diff] [blame]36
37 <li>
38 <a class="sidebar-nav-heading" data-toggle="collapse"
39 href="#installing-menu" aria-expanded="false"
40 aria-controls="installing-menu">
41 Installing Bazel<span class="caret"></span>
42 </a>
43 <ul class="collapse sidebar-nav sidebar-submenu" id="installing-menu">
44 <li><a href="/versions/{{ site.version }}/install.html">Installation Overview</a></li>
45 <li><a href="/versions/{{ site.version }}/install-ubuntu.html">Installing on Ubuntu</a></li>
46 <li><a href="/versions/{{ site.version }}/install-redhat.html">Installing on Fedora/CentOS</a></li>
47 <li><a href="/versions/{{ site.version }}/install-os-x.html">Installing on macOS</a></li>
48 <li><a href="/versions/{{ site.version }}/install-windows.html">Installing on Windows</a></li>
49 <li><a href="/versions/{{ site.version }}/install-compile-source.html">Compiling from Source</a></li>
Laszlo Csomor7b6d2fa2018-10-25 07:04:33 -0700[diff] [blame]50 <li><a href="/versions/{{ site.version }}/completion.html">Command-Line Completion</a></li>
laurentlbc7914152018-02-23 09:29:18 -0800[diff] [blame]51 <li><a href="/versions/{{ site.version }}/ide.html">Integrating with IDEs</a></li>
52 </ul>
53 </li>
54
55 <li>
56 <a class="sidebar-nav-heading" data-toggle="collapse"
57 href="#tutorials-menu" aria-expanded="false"
58 aria-controls="tutorials-menu">
59 Tutorials<span class="caret"></span>
60 </a>
61 <ul class="collapse sidebar-nav sidebar-submenu" id="tutorials-menu">
62 <li><a href="/versions/{{ site.version }}/tutorial/java.html">Building a Java Project</a></li>
63 <li><a href="/versions/{{ site.version }}/tutorial/cpp.html">Building a C++ Project</a></li>
64 <li><a href="/versions/{{ site.version }}/tutorial/android-app.html">Building an Android App</a></li>
65 <li><a href="/versions/{{ site.version }}/tutorial/ios-app.html">Building an iOS App</a></li>
66 <li><a href="/versions/{{ site.version }}/skylark/tutorial-sharing-variables.html">Sharing Variables</a></li>
brandjon3ef60b72018-03-18 06:26:11 -0700[diff] [blame]67 <li><a href="/versions/{{ site.version }}/skylark/tutorial-creating-a-macro.html">Creating a Macro</a></li>
laurentlbc7914152018-02-23 09:29:18 -0800[diff] [blame]68 </ul>
69 </li>
70
laurentlb4a8f7ae2018-10-08 08:01:11 -0700[diff] [blame]71 <li><a href="/versions/{{ site.version }}/build-ref.html">Bazel Concepts</a></li>
laurentlbadf36072018-11-05 16:20:20 -0800[diff] [blame]72 <li><a href="/versions/{{ site.version }}/guide.html">User's Guide</a></li>
laurentlb9d4186f2018-10-03 11:57:46 -0700[diff] [blame]73 <li><a href="/versions/{{ site.version }}/external.html">External Dependencies</a></li>
laurentlb9a268232018-10-03 08:37:11 -0700[diff] [blame]74
75 <li>
76 <a class="sidebar-nav-heading" data-toggle="collapse"
77 href="#query-menu" aria-expanded="false"
78 aria-controls="query-menu">
79 Queries<span class="caret"></span>
80 </a>
81 <ul class="collapse sidebar-nav sidebar-submenu" id="query-menu">
82 <li><a href="/versions/{{ site.version }}/query-how-to.html">Bazel query</a></li>
83 <li><a href="/versions/{{ site.version }}/cquery.html">Bazel cquery</a></li>
84 <li><a href="/versions/{{ site.version }}/user-manual.html#aquery">Bazel aquery</a></li>
85 <li><a href="/versions/{{ site.version }}/query.html">Query Language</a></li>
86 </ul>
87 </li>
88
laurentlb875cc912018-09-28 06:52:59 -0700[diff] [blame]89 <li><a href="/versions/{{ site.version }}/configurable-attributes.html">Configurable Attributes</a></li>
90 <li><a href="/versions/{{ site.version }}/best-practices.html">Best Practices</a></li>
michelleirvine25660fb2018-10-05 09:47:51 -0700[diff] [blame]91 <li>
92 <a class="sidebar-nav-heading" data-toggle="collapse"
93 href="#remote-execution-menu" aria-expanded="false"
94 aria-controls="remote-execution-menu">
95 Remote Execution<span class="caret"></span>
96 </a>
97 <ul class="collapse sidebar-nav sidebar-submenu" id="remote-execution-menu">
98 <li><a href="/versions/{{ site.version }}/remote-execution.html">Remote Execution Overview</a></li>
99 <li><a href="/versions/{{ site.version }}/remote-execution-rules.html">Guidelines for Remote Execution</a></li>
Googlerdc9ee642018-11-16 15:22:20 -0800[diff] [blame]100 <li>
101 <a class="sidebar-nav-heading" data-toggle="collapse"
102 href="#troubleshoot-remote-execution-menu" aria-expanded="false"
103 aria-controls="troubleshoot-remote-execution-menu">
104 Troubleshooting Remote Execution<span class="caret"></span>
105 </a>
106 <ul class="collapse sidebar-nav sidebar-submenu" id="troubleshoot-remote-execution-menu">
107 <li><a href="/versions/{{ site.version }}/remote-execution-sandbox.html">Troubleshooting Remote Execution with Bazel Sandbox</a></li>
108 <li><a href="/versions/{{ site.version }}/workspace-log.html">Finding non-hermetic behavior in WORKSPACE rules</a></li>
Googler2af641c2018-11-26 03:01:41 -0800[diff] [blame]109 <li><a href="/versions/{{ site.version }}/remote-execution-caching-debug.html">Debugging Remote Cache Hit Rate</a></li>
Googlerdc9ee642018-11-16 15:22:20 -0800[diff] [blame]110 </ul>
111 </li>
spomorski766b2ec2018-10-09 06:21:20 -0700[diff] [blame]112 <li><a href="/versions/{{ site.version }}/remote-execution-ci.html">Configuring Bazel CI for Remote Execution Rule Testing</a></li>
michelleirvine25660fb2018-10-05 09:47:51 -0700[diff] [blame]113 </ul>
114 </li>
115
Googlerd96c9082018-11-28 09:00:04 -0800[diff] [blame^]116 <li>
117 <a class="sidebar-nav-heading" data-toggle="collapse"
118 href="#remote-caching-menu" aria-expanded="false"
119 aria-controls="remote-caching-menu">
120 Remote Caching<span class="caret"></span>
121 </a>
122 <ul class="collapse sidebar-nav sidebar-submenu" id="remote-caching-menu">
123 <li><a href="/versions/{{ site.version }}/remote-caching.html">Remote Caching Overview</a></li>
124 <li><a href="/versions/{{ site.version }}/remote-caching-debug.html">Debugging Remote Cache Hit Rate for Local Execution</a></li>
125 </ul>
126 </li>
michelleirvine25660fb2018-10-05 09:47:51 -0700[diff] [blame]127 </ul>
Googler7b30d752017-07-17 16:35:17 +0200[diff] [blame]128
laurentlb875cc912018-09-28 06:52:59 -0700[diff] [blame]129 <h3>Rules</h3>
130 <ul class="sidebar-nav">
131 <li><a href="/versions/{{ site.version }}/be/overview.html">Build Encyclopedia</a></li>
spomorski97a932f2018-06-04 10:16:44 -0700[diff] [blame]132
133 <li>
134 <a class="sidebar-nav-heading" data-toggle="collapse"
Googlerd1bd9d62017-09-13 21:21:50 +0200[diff] [blame]135 href="#android-menu" aria-expanded="false"
136 aria-controls="android-menu">
laurentlb875cc912018-09-28 06:52:59 -0700[diff] [blame]137 Android<span class="caret"></span>
Googlerd1bd9d62017-09-13 21:21:50 +0200[diff] [blame]138 </a>
139 <ul class="collapse sidebar-nav sidebar-submenu" id="android-menu">
spomorskicc16d4c2017-12-07 14:09:21 -0800[diff] [blame]140 <li><a href="/versions/{{ site.version }}/bazel-and-android.html">Android Resources</a></li>
ahumesky71c14412017-12-08 11:55:53 -0800[diff] [blame]141 <li><a href="/versions/{{ site.version }}/mobile-install.html">Using mobile-install</a></li>
jingwenb29b5bf2018-07-12 10:21:10 -0700[diff] [blame]142 <li><a href="/versions/{{ site.version }}/android-instrumentation-test.html">Android Instrumentation Tests</a></li>
143 <li><a href="/versions/{{ site.version }}/android-ndk.html">Android NDK</a></li>
144 <li><a href="https://plugins.jetbrains.com/plugin/9185-bazel">Android Studio Plugin</a></li>
Googlerd1bd9d62017-09-13 21:21:50 +0200[diff] [blame]145 </ul>
146 </li>
147
148 <li>
149 <a class="sidebar-nav-heading" data-toggle="collapse"
150 href="#apple-menu" aria-expanded="false"
151 aria-controls="apple-menu">
laurentlb875cc912018-09-28 06:52:59 -0700[diff] [blame]152 Apple<span class="caret"></span>
Googlerd1bd9d62017-09-13 21:21:50 +0200[diff] [blame]153 </a>
154 <ul class="collapse sidebar-nav sidebar-submenu" id="apple-menu">
spomorskicc16d4c2017-12-07 14:09:21 -0800[diff] [blame]155 <li><a href="/versions/{{ site.version }}/bazel-and-apple.html">Apple Resources</a></li>
ahumesky71c14412017-12-08 11:55:53 -0800[diff] [blame]156 <li><a href="/versions/{{ site.version }}/migrate-xcode.html">Migrating from Xcode</a></li>
157 <li><a href="/versions/{{ site.version }}/migrate-cocoapods.html">Converting CocoaPods</a></li>
Googlerd1bd9d62017-09-13 21:21:50 +0200[diff] [blame]158 </ul>
159 </li>
spomorskicc16d4c2017-12-07 14:09:21 -0800[diff] [blame]160
laurentlb875cc912018-09-28 06:52:59 -0700[diff] [blame]161 <li>
162 <a class="sidebar-nav-heading" data-toggle="collapse"
163 href="#cpp-menu" aria-expanded="false"
164 aria-controls="cpp-menu">
165 C++<span class="caret"></span>
166 </a>
167 <ul class="collapse sidebar-nav sidebar-submenu" id="cpp-menu">
168 <li><a href="/versions/{{ site.version }}/bazel-and-cpp.html">C++ Resources</a></li>
169 <li><a href="/versions/{{ site.version }}/cpp-use-cases.html">C++ Use Cases</a></li>
spomorskiad0079b2018-10-02 10:35:57 -0700[diff] [blame]170 <li><a href="/versions/{{ site.version }}/crosstool-reference.html">Understanding CROSSTOOL</a></li>
171 <li><a href="/versions/{{ site.version }}/tutorial/crosstool.html">Tutorial: CROSSTOOL</a></li>
laurentlb875cc912018-09-28 06:52:59 -0700[diff] [blame]172 </ul>
173 </li>
174
175 <li>
176 <a class="sidebar-nav-heading" data-toggle="collapse"
177 href="#java-menu" aria-expanded="false"
178 aria-controls="java-menu">
179 Java<span class="caret"></span>
180 </a>
181 <ul class="collapse sidebar-nav sidebar-submenu" id="java-menu">
182 <li><a href="/versions/{{ site.version }}/bazel-and-java.html">Java Resources</a></li>
183 <li><a href="/versions/{{ site.version }}/migrate-maven.html">Migrating from Maven</a></li>
184 <li><a href="/versions/{{ site.version }}/generate-workspace.html">Converting Maven Dependencies</a></li>
185 </ul>
186 </li>
187
188 <li>
189 <a class="sidebar-nav-heading" data-toggle="collapse"
190 href="#javascript-menu" aria-expanded="false"
191 aria-controls="javascript-menu">
192 JavaScript<span class="caret"></span>
193 </a>
194 <ul class="collapse sidebar-nav sidebar-submenu" id="javascript-menu">
195 <li><a href="/versions/{{ site.version }}/bazel-and-javascript.html">JavaScript Resources</a></li>
196 <li><a href="/versions/{{ site.version }}/build-javascript.html">Building JavaScript</a></li>
197 </ul>
198 </li>
199
200 </ul>
201
202 <h3>Reference</h3>
spomorskicc16d4c2017-12-07 14:09:21 -0800[diff] [blame]203 <ul class="sidebar-nav">
laurentlb27453bf2018-10-08 11:23:18 -0700[diff] [blame]204 <li><a href="/versions/{{ site.version }}/user-manual.html">Commands and Options</a></li>
brandjon3ef60b72018-03-18 06:26:11 -0700[diff] [blame]205 <li><a href="/versions/{{ site.version }}/skylark/build-style.html">BUILD Style Guide</a></li>
spomorskicc16d4c2017-12-07 14:09:21 -0800[diff] [blame]206 <li><a href="/versions/{{ site.version }}/command-line-reference.html">Command Line Reference</a></li>
laurentlb4a8f7ae2018-10-08 08:01:11 -0700[diff] [blame]207 <li><a href="/versions/{{ site.version }}/test-encyclopedia.html">Writing Tests</a></li>
spomorskicc16d4c2017-12-07 14:09:21 -0800[diff] [blame]208 <li><a href="/versions/{{ site.version }}/build-event-protocol.html">Build Event Protocol</a></li>
spomorskicc16d4c2017-12-07 14:09:21 -0800[diff] [blame]209 <li><a href="/versions/{{ site.version }}/output_directories.html">Output Directory Layout</a></li>
210 <li><a href="/versions/{{ site.version }}/platforms.html">Platforms</a></li>
211 <li><a href="/versions/{{ site.version }}/toolchains.html">Toolchains</a></li>
212 </ul>
213
spomorskieb20b062017-12-11 07:56:13 -0800[diff] [blame]214 <h3>Extending Bazel</h3>
spomorskicc16d4c2017-12-07 14:09:21 -0800[diff] [blame]215 <ul class="sidebar-nav">
brandjon6d438602018-03-19 10:24:56 -0700[diff] [blame]216 <li><a href="/versions/{{ site.version }}/skylark/concepts.html">Extension Overview</a></li>
laurentlb3beea112017-07-17 20:28:51 +0200[diff] [blame]217
218 <li>
219 <a class="sidebar-nav-heading" data-toggle="collapse"
laurentlbd1827a82018-08-17 07:04:25 -0700[diff] [blame]220 href="#starlark-concepts" aria-expanded="false"
221 aria-controls="starlark-concepts">
laurentlb9177db12017-12-12 08:41:28 -0800[diff] [blame]222 Concepts<span class="caret"></span>
laurentlba5be5582017-07-21 15:10:54 +0200[diff] [blame]223 </a>
laurentlbd1827a82018-08-17 07:04:25 -0700[diff] [blame]224 <ul class="collapse sidebar-nav sidebar-submenu" id="starlark-concepts">
laurentlb3beea112017-07-17 20:28:51 +0200[diff] [blame]225 <li><a href="/versions/{{ site.version }}/skylark/macros.html">Macros</a></li>
226 <li><a href="/versions/{{ site.version }}/skylark/rules.html">Rules</a></li>
laurentlb9177db12017-12-12 08:41:28 -0800[diff] [blame]227 <li><a href="/versions/{{ site.version }}/skylark/depsets.html">Depsets</a></li>
228 <li><a href="/versions/{{ site.version }}/skylark/aspects.html">Aspects</a></li>
spomorskicc16d4c2017-12-07 14:09:21 -0800[diff] [blame]229 <li><a href="/versions/{{ site.version }}/skylark/repository_rules.html">Repository Rules</a></li>
brandjon3ef60b72018-03-18 06:26:11 -0700[diff] [blame]230 <li><a href="/versions/{{ site.version }}/skylark/faq.html">FAQ</a></li>
laurentlb3beea112017-07-17 20:28:51 +0200[diff] [blame]231 </ul>
232 </li>
laurentlb9177db12017-12-12 08:41:28 -0800[diff] [blame]233
234 <li>
235 <a class="sidebar-nav-heading" data-toggle="collapse"
laurentlbd1827a82018-08-17 07:04:25 -0700[diff] [blame]236 href="#starlark-practices" aria-expanded="false"
237 aria-controls="starlark-practices">
laurentlb9177db12017-12-12 08:41:28 -0800[diff] [blame]238 Best Practices<span class="caret"></span>
239 </a>
laurentlbd1827a82018-08-17 07:04:25 -0700[diff] [blame]240 <ul class="collapse sidebar-nav sidebar-submenu" id="starlark-practices">
brandjon3ef60b72018-03-18 06:26:11 -0700[diff] [blame]241 <li><a href="/versions/{{ site.version }}/skylark/bzl-style.html">.bzl Style Guide</a></li>
brandjon9c5c19d2018-04-23 13:19:17 -0700[diff] [blame]242 <li><a href="/versions/{{ site.version }}/skylark/testing.html">Testing</a></li>
laurentlb9177db12017-12-12 08:41:28 -0800[diff] [blame]243 <li><a href="https://skydoc.bazel.build" target="_blank">Documenting Rules</a></li>
laurentlb749165f2017-12-14 03:41:55 -0800[diff] [blame]244 <li><a href="/versions/{{ site.version }}/skylark/skylint.html">Linter</a></li>
laurentlb9177db12017-12-12 08:41:28 -0800[diff] [blame]245 <li><a href="/versions/{{ site.version }}/skylark/performance.html">Optimizing Performance</a></li>
246 <li><a href="/versions/{{ site.version }}/skylark/deploying.html">Deploying Rules</a></li>
247 </ul>
248 </li>
249
laurentlb85ffdb72017-12-15 04:28:10 -0800[diff] [blame]250 <li><a href="https://github.com/bazelbuild/examples/tree/master/rules">Examples</a></li>
laurentlb9177db12017-12-12 08:41:28 -0800[diff] [blame]251 <li><a href="/versions/{{ site.version }}/skylark/lib/skylark-overview.html">API Reference</a></li>
laurentlbd1827a82018-08-17 07:04:25 -0700[diff] [blame]252 <li><a href="/versions/{{ site.version }}/skylark/language.html">Starlark Language</a></li>
spomorski66ed2292017-10-24 19:38:14 +0200[diff] [blame]253 </ul>
David Chenbd690802016-04-26 07:12:42 +0000[diff] [blame]254 </nav>
255 </div>
spomorskicc16d4c2017-12-07 14:09:21 -0800[diff] [blame]256
Jingwen6060c792017-12-11 05:22:52 -0800[diff] [blame]257 <div class="col-md-9">
sterenbbb9bbc2017-05-21 14:32:03 +0200[diff] [blame]258 <a id="gh-edit" class="gh-edit default-hidden"><i class="fa fa-pencil" aria-hidden="true"></i> Edit</a>
Steren Giannini8dd69b62017-05-17 22:50:19 +0200[diff] [blame]259 <script>
steren9b394a22017-06-27 17:38:41 +0200[diff] [blame]260 var versionDocsURLRegex = /\/versions\/[\w\.]+\/(.*)/;
dzc5596d3b2017-06-07 21:51:52 -0400[diff] [blame]261 var ghDocsBazeURL = 'https://github.com/bazelbuild/bazel/tree/master/site/docs/';
Steren Giannini8dd69b62017-05-17 22:50:19 +0200[diff] [blame]262 var editButton = document.getElementById('gh-edit');
steren9b394a22017-06-27 17:38:41 +0200[diff] [blame]263 // if there is an edit button and we are not in the Build Encyclopedia
dzc5596d3b2017-06-07 21:51:52 -0400[diff] [blame]264 if (editButton
steren9b394a22017-06-27 17:38:41 +0200[diff] [blame]265 && window.location.pathname.match(versionDocsURLRegex)
steren45d1c372017-07-10 14:54:53 +0200[diff] [blame]266 && window.location.pathname.lastIndexOf('/be/') == -1
267 && window.location.pathname.lastIndexOf('/skylark/lib/') == -1) {
steren9b394a22017-06-27 17:38:41 +0200[diff] [blame]268 var docFile = window.location.pathname.match(versionDocsURLRegex)[1];
steren45d1c372017-07-10 14:54:53 +0200[diff] [blame]269 // some pages are not using markdown :(
Jingwen Chen7633ab02018-03-05 09:30:14 -0800[diff] [blame]270 if (docFile !== 'user-manual.html'
dzc5596d3b2017-06-07 21:51:52 -0400[diff] [blame]271 && docFile !== 'build-ref.html'
272 && docFile !== 'query.html'
273 && docFile !== 'test-encyclopedia.html') {
Steren Giannini8dd69b62017-05-17 22:50:19 +0200[diff] [blame]274 docFile = docFile.replace('html', 'md');
275 }
276 editButton.href = ghDocsBazeURL + docFile;
277 editButton.style.visibility = 'visible';
278 }
279 </script>
280
David Chenbd690802016-04-26 07:12:42 +0000[diff] [blame]281 {{ content }}
282 </div>
283 </div>
284 </div>
285
spomorskicc16d4c2017-12-07 14:09:21 -0800[diff] [blame]286 <!-- Satisfaction Survey -->
Steren Giannini60b28122017-05-15 14:55:34 +0200[diff] [blame]287 <script async="" defer="" src="//survey.g.doubleclick.net/async_survey?site=oohdpic4fyfp3jcnym6aqkdf3e"></script>
288
David Chenbd690802016-04-26 07:12:42 +0000[diff] [blame]289 {% include footer.html %}
290 </body>
291</html>
michelleirvine25660fb2018-10-05 09:47:51 -0700[diff] [blame]292