blob: e68cffbd9be5edf6633feb7d59ed3707e3ce1a6c (
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
|
// Copyright 2014 The Bazel Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.devtools.build.lib.bazel.rules.workspace;
import static com.google.devtools.build.lib.packages.Attribute.attr;
import static com.google.devtools.build.lib.syntax.Type.STRING;
import com.google.devtools.build.lib.analysis.RuleDefinition;
import com.google.devtools.build.lib.analysis.RuleDefinitionEnvironment;
import com.google.devtools.build.lib.packages.RuleClass;
import com.google.devtools.build.lib.packages.RuleClass.Builder;
import com.google.devtools.build.lib.packages.RuleClass.Builder.RuleClassType;
/**
* Rule definition for the local_repository rule.
*/
public class LocalRepositoryRule implements RuleDefinition {
public static final String NAME = "local_repository";
@Override
public RuleClass build(Builder builder, RuleDefinitionEnvironment environment) {
return builder
/* <!-- #BLAZE_RULE(local_repository).ATTRIBUTE(path) -->
The path to the local repository's directory.
${SYNOPSIS}
<p>This must be an absolute path to the directory containing the repository's
<i>WORKSPACE</i> file.</p>
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(attr("path", STRING).mandatory())
.setWorkspaceOnly()
.build();
}
@Override
public Metadata getMetadata() {
return RuleDefinition.Metadata.builder()
.name(LocalRepositoryRule.NAME)
.type(RuleClassType.WORKSPACE)
.ancestors(WorkspaceBaseRule.class)
.factoryClass(WorkspaceConfiguredTargetFactory.class)
.build();
}
}
/*<!-- #BLAZE_RULE (NAME = local_repository, TYPE = OTHER, FAMILY = Workspace)[GENERIC_RULE] -->
${ATTRIBUTE_SIGNATURE}
<p>Allows targets from a local directory to be bound. This means that the current repository can
use targets defined in this other directory. See the <a href="#bind_examples">bind section</a>
for more details.</p>
${ATTRIBUTE_DEFINITION}
<h4 id="local_repository_examples">Examples</h4>
<p>Suppose the current repository is a chat client, rooted at the directory <i>~/chat-app</i>. It
would like to use an SSL library which is defined in a different repository: <i>~/ssl</i>. The
SSL library has a target <code>//src:openssl-lib</code>.</p>
<p>The user can add a dependency on this target by adding the following lines to
<i>~/chat-app/WORKSPACE</i>:</p>
<pre class="code">
local_repository(
name = "my-ssl",
path = "/home/user/ssl",
)
</pre>
<p>Targets would specify <code>@my-ssl//src:openssl-lib</code> as a dependency to depend on this
library.</p>
<!-- #END_BLAZE_RULE -->*/
|
