Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove the proto rules #2739

Merged
merged 6 commits into from
Mar 22, 2023
Merged

Remove the proto rules #2739

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
508bcb3
Remove the proto rules1
Tatskaari Mar 21, 2023
f892e29
Merge branch 'master' into remove-proto-rules
Tatskaari Mar 21, 2023
1a30a8c
Merge branch 'master' into remove-proto-rules
Tatskaari Mar 22, 2023
383ac50
Update docs and config
Tatskaari Mar 22, 2023
a9836d2
fix rules test
Tatskaari Mar 22, 2023
a850eff
Merge branch 'master' into remove-proto-rules
Tatskaari Mar 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
176 changes: 0 additions & 176 deletions docs/config.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1637,182 +1637,6 @@ <h3 class="mt1 f6 lh-title" id="python.interpreteroptions">InterpreterOptions</h
</ul>
</section>

<section class="mt4">
<h2 id="proto" class="title-2">[Proto]</h2>

<p>
Properties that affect how the <code class="code">proto_library</code> and
<code class="code">grpc_library</code> rules work.
</p>

<p>
As noted elsewhere, these rules are fairly complex and do a bunch of things
internally, so they correspondingly have a lot of options here.
</p>

<p>
Obviously the various gRPC-related properties only apply to
<code class="code">grpc_library</code> rules, whereas
<code class="code">proto_library</code> rules are affected by all of them.
</p>

<ul class="bulleted-list">
<li>
<div>
<h3 class="mt1 f6 lh-title" id="proto.protoctool">ProtocTool</h3>

<p>
The binary invoked to compile .proto files. Defaults to
<code class="code">protoc</code>.
</p>
</div>
</li>
<li>
<div>
<h3 class="mt1 f6 lh-title" id="proto.protocflag">ProtocFlag</h3>

<p>
Flags to pass to all protoc invocations. This can be used to set the location of well known types. It is
recommended to use <code>protoc_binary</code> which will manage the well known types for you, however you may
set this to <code class="code">-I/usr/local/include</code> or similar to use the well known
types from the host machine.
</p>
</div>
</li>
<li>
<div>
<h3 class="mt1 f6 lh-title" id="proto.protocgoplugin">ProtocGoPlugin</h3>

<p>
The binary passed to protoc as a plugin to generate Go code. Defaults
to <code class="code">protoc-gen-go</code>.<br />
We've found this easier to manage with a
<code class="code">go_get</code> rule instead though, so you can also
pass a build label here. See the Please repo for an example.
</p>
</div>
</li>
<li>
<div>
<h3 class="mt1 f6 lh-title" id="proto.grpcgoplugin"> GrpcGoPlugin</h3>
<p>{{ index .ConfigHelpText "proto.grpcgoplugin" }}</p>
</div>
</li>
<li>
<div>
<h3 class="mt1 f6 lh-title" id="proto.grpcccplugin"> GrpcCcPlugin</h3>
<p>{{ index .ConfigHelpText "proto.grpcccplugin" }}</p>
</div>
</li>
<li>
<div>
<h3 class="mt1 f6 lh-title" id="proto.grpcpythonplugin">GrpcPythonPlugin</h3>

<p>
The plugin invoked to compile Python code for
<code class="code">grpc_library</code>.<br />
Defaults to <code class="code">grpc_python_plugin</code>.
</p>
</div>
</li>
<li>
<div>
<h3 class="mt1 f6 lh-title" id="proto.grpcjavaplugin">GrpcJavaPlugin</h3>

<p>
The plugin invoked to compile Java code for
<code class="code">grpc_library</code>.<br />
Defaults to <code class="code">protoc-gen-grpc-java</code>.
</p>
</div>
</li>
<li>
<div>
<h3 class="mt1 f6 lh-title" id="proto.language">
Language <span class="normal">(repeated string)</span>
</h3>

<p>
Sets the default set of languages that proto rules are built for.<br />
Chosen from the set of {<code class="code">cc</code>,
<code class="code">java</code>, <code class="code">go</code>,
<code class="code">py</code>}.<br />
Defaults to multiple <code class="code">Language</code> lines, one
line for each of the following values: <code class="code">cc</code>,
<code class="code">py</code>, <code class="code">java</code>,
<code class="code">go</code>, and <code class="code">js</code>.
</p>
</div>
</li>
<li>
<div>
<h3 class="mt1 f6 lh-title" id="proto.pythondep">PythonDep</h3>

<p>
An in-repo dependency that's applied to any Python targets built.
Defaults to <code class="code">//third_party/python:protobuf</code>.
</p>
</div>
</li>
<li>
<div>
<h3 class="mt1 f6 lh-title" id="proto.javadep">JavaDep</h3>

<p>
An in-repo dependency that's applied to any Java targets built.
Defaults to <code class="code">//third_party/java:protobuf</code>.
</p>
</div>
</li>
<li>
<div>
<h3 class="mt1 f6 lh-title" id="proto.godep">GoDep</h3>

<p>
An in-repo dependency that's applied to any Go targets built. Defaults
to <code class="code">//third_party/go:protobuf</code>.
</p>
</div>
</li>
<li>
<div>
<h3 class="mt1 f6 lh-title" id="proto.pythongrpcdep">PythonGrpcDep</h3>

<p>
An in-repo dependency that's applied to any Python gRPC targets built.
Defaults to <code class="code">//third_party/python:grpc</code>.
</p>
</div>
</li>
<li>
<div>
<h3 class="mt1 f6 lh-title" id="proto.javagrpcdep">JavaGrpcDep</h3>

<p>
An in-repo dependency that's applied to any Java gRPC targets built.
Defaults to <code class="code">/third_party/java:grpc-all</code>.
</p>
</div>
</li>
<li>
<div>
<h3 class="mt1 f6 lh-title" id="proto.gogrpcdep">GoGrpcDep</h3>

<p>
An in-repo dependency that's applied to any Go gRPC targets built.
Defaults to <code class="code">//third_party/go:grpc</code>.
</p>
</div>
</li>
<li>
<div>
<h3 class="mt1 f6 lh-title" id="proto.jsdep">JsDep</h3>
<p>{{ index .ConfigHelpText "proto.jsdep" }}</p>
</div>
</li>
</ul>
</section>

<section class="mt4">
<h2 id="licences" class="title-2">[Licences]</h2>

Expand Down
26 changes: 0 additions & 26 deletions docs/lexicon.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,6 @@ <h1 class="title-1">The Lexicon of Please</h1>
<a class="copy-link" href="#misc">Miscellaneous rules</a>
</span>
</li>
<li>
<span>
<a class="copy-link" href="#proto">Protocol buffer rules</a>
</span>
</li>
<li>
<span>
<a class="copy-link" href="#subrepo">Subrepo rules</a>
Expand Down Expand Up @@ -1376,27 +1371,6 @@ <h3 class="title-3" id="git_state">
</section>
</section>

<section class="mt4">
<h2 class="title-2" id="proto">
Proto rules
</h2>

<p>Build rules for compiling protocol buffers &amp; gRPC service stubs.</p>

<p>
Note that these are some of the most complex of our built-in build rules,
because of their cross-language nature. Each proto_library rule declares a
set of sub-rules to run protoc &amp; the appropriate java_library,
go_library rules etc. Users shouldn't worry about those sub-rules and just
declare a dependency directly on the proto_library rule to get its
appropriate outputs.
</p>

<!-- prettier-ignore -->
{{ template "lexicon_entry.html" .Named "proto_library" }}
{{ template "lexicon_entry.html" .Named "grpc_library" }}
{{ template "lexicon_entry.html" .Named "proto_language" }}
</section>

<section class="mt4">
<h2 class="title-2" id="subrepo">
Expand Down
2 changes: 1 addition & 1 deletion docs/template.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@
<li class="pl4" role="menuitem">
<a
class="silver no-underline"
href="/lexicon.html#proto"
href="/plugins.html#proto"
>Protobuf rules</a
>
</li>
Expand Down