aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/docgen/templates/be/overview.vm
blob: 3a663082842b47055765c1350b2b7a24853c5f49 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
#parse("com/google/devtools/build/docgen/templates/be/header.vm")

<h1>Bazel BUILD Encyclopedia of Functions</h1>
<h2>Contents</h2>

<h3>Concepts and terminology</h3>

<ul>
  <li>
    <a href="common-definitions.html">Common definitions</a>
    <ul>
      <li><a href="common-definitions.html#sh-tokenization">Bourne shell tokenization</a></li>
      <li><a href="common-definitions.html#label-expansion">Label expansion</a></li>
      <li><a href="common-definitions.html#common-attributes">Common attributes</a></li>
      <li><a href="common-definitions.html#common-attributes-tests">Common attributes for tests</a></li>
      <li><a href="common-definitions.html#common-attributes-binaries">Common attributes for binaries</a></li>
      <li><a href="common-definitions.html#configurable-attributes">Configurable attributes</a></li>
      <li><a href="common-definitions.html#implicit-outputs">Implicit output targets</a></li>
    </ul>
  </li>
  <li>
    <a href="make-variables.html">"Make" variables</a>
    <ul class="be-toc">
      <li><a href="make-variables.html#make-var-substitution">"Make" variable substitution</a></li>
      <li><a href="make-variables.html#predefined_variables">Predefined variables</a></li>

    </ul>
  </li>
  <li><a href="predefined-python-variables.html">Predefined Python Variables</a></li>
</ul>

<h3>Functions</h3>

<ul class="be-toc">
  <li><a href="functions.html#load">load</a></li>

  <li><a href="functions.html#package">package</a></li>
  <li><a href="functions.html#package_group">package_group</a></li>

  <li><a href="functions.html#licenses">licenses</a></li>
  <li><a href="functions.html#exports_files">exports_files</a></li>
  <li><a href="functions.html#glob">glob</a></li>
  <li><a href="functions.html#select">select</a></li>
  <li><a href="functions.html#workspace">workspace</a></li>
</ul>

<h3>Rules</h3>

<h4>Language-specific Rules</h4>

#macro(summaryTable $ruleFamilies)
  <tbody>
  #foreach($ruleFamily in $ruleFamilies)
    <tr>
      <td class="lang">${ruleFamily.name}</td>
      <td>
    #foreach($ruleDoc in $ruleFamily.binaryRules)
      <a href="${ruleFamily.id}.html#${ruleDoc.ruleName}"#if($ruleDoc.isDeprecated()) class="deprecated"#end>
          ${ruleDoc.ruleName}
        </a>
        <br />
    #end
      </td>
      <td>
    #foreach($ruleDoc in $ruleFamily.libraryRules)
      <a href="${ruleFamily.id}.html#${ruleDoc.ruleName}"#if($ruleDoc.isDeprecated()) class="deprecated"#end>
          ${ruleDoc.ruleName}
        </a>
        <br />
    #end
      </td>
      <td>
    #foreach($ruleDoc in $ruleFamily.testRules)
      <a href="${ruleFamily.id}.html#${ruleDoc.ruleName}"#if($ruleDoc.isDeprecated()) class="deprecated"#end>
          ${ruleDoc.ruleName}
        </a>
        <br />
    #end
      </td>
      <td>
    #foreach($ruleDoc in $ruleFamily.otherRules1)
      <a href="${ruleFamily.id}.html#${ruleDoc.ruleName}"#if($ruleDoc.isDeprecated()) class="deprecated"#end>
          ${ruleDoc.ruleName}
        </a>
        <br />
    #end
      </td>
      <td>
    #foreach($ruleDoc in $ruleFamily.otherRules2)
      <a href="${ruleFamily.id}.html#${ruleDoc.ruleName}"#if($ruleDoc.isDeprecated()) class="deprecated"#end>
          ${ruleDoc.ruleName}
        </a>
        <br />
    #end
      </td>
    </tr>
  #end
  </tbody>
#end

<table class="table table-condensed table-striped" summary="Table of rules sorted by language">
  <colgroup span="6" width="20%"></colgroup>
  <thead>
    <tr>
      <th>Language</th>
      <th>Binary rules</th>
      <th>Library rules</th>
      <th>Test rules</th>
      <th>Other rules</th>
      <th></th>
    </tr>
  </thead>
#summaryTable($langSpecificSummaryFamilies)

</table>
<h4>Rules that do not apply to a specific programming language</h4>

<table class="table table-condensed table-striped" summary="Table of rules not specific to a programming language">
  <colgroup span="6" width="20%"></colgroup>
#summaryTable($otherSummaryFamilies)

</table>