grpc/cpp/md_doc_bazel_support.html

109 lines
5.4 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GRPC C++: Bazel Support</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">GRPC C++
&#160;<span id="projectnumber">1.64.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">Bazel Support </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h1><a class="anchor" id="autotoc_md30"></a>
Basic Usage</h1>
<p>The <code>grpc/grpc</code> repository's primary build system is Bazel. Rules are provided for C++, Python, and Objective-C. While C++ supports other build systems such as CMake, these rules are actually generated from the Bazel definitions.</p>
<p>Projects built with Bazel may use the <code>grpc/grpc</code> repo not only to add a dependency on the library itself, but also to generate protobuf, stub, and servicer code. To do so, one must invoke the <code>grpc_deps</code> and <code>grpc_extra_deps</code> repository rules in their <code>WORKSPACE</code> file:</p>
<div class="fragment"><div class="line">workspace(name = &quot;example_workspace&quot;)</div>
<div class="line"> </div>
<div class="line">load(&quot;@bazel_tools//tools/build_defs/repo:http.bzl&quot;, &quot;http_archive&quot;)</div>
<div class="line"> </div>
<div class="line">http_archive(</div>
<div class="line"> name = &quot;com_github_grpc_grpc&quot;,</div>
<div class="line"> strip_prefix = &quot;grpc-1.45.0&quot;,</div>
<div class="line"> sha256 = &quot;ec19657a677d49af59aa806ec299c070c882986c9fcc022b1c22c2a3caf01bcd&quot;,</div>
<div class="line"> urls = [&quot;https://github.com/grpc/grpc/archive/refs/tags/v1.45.0.tar.gz&quot;],</div>
<div class="line">)</div>
<div class="line"> </div>
<div class="line">load(&quot;@com_github_grpc_grpc//bazel:grpc_deps.bzl&quot;, &quot;grpc_deps&quot;)</div>
<div class="line"> </div>
<div class="line">grpc_deps()</div>
<div class="line"> </div>
<div class="line">load(&quot;@com_github_grpc_grpc//bazel:grpc_extra_deps.bzl&quot;, &quot;grpc_extra_deps&quot;)</div>
<div class="line"> </div>
<div class="line">grpc_extra_deps()</div>
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md31"></a>
Supported Versions</h1>
<p>gRPC supports building with the latest stable release of Bazel, as well as the previous major version release for at least 6 months after it transitions into maintenance mode. This is consistent with the supported build systems of <a href="https://opensource.google/documentation/policies/cplusplus-support">the Google Foundational C++ Support Policy</a>. However individual releases may have a broader compatibility range. The currently supported versions are captured by the following list:</p>
<ul>
<li><a href="https://github.com/bazelbuild/bazel/releases/tag/7.1.0"><code>7.1.0</code></a></li>
<li><a href="https://github.com/bazelbuild/bazel/releases/tag/6.5.0"><code>6.5.0</code></a></li>
</ul>
<p>NOTE: gRPC doesn't support bzlmod yet. </p>
</div></div><!-- contents -->
</div><!-- PageDoc -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri May 17 2024 01:17:16 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>