mirror of
https://github.com/bazel-contrib/rules_foreign_cc
synced 2024-11-30 16:42:07 +00:00
955 lines
157 KiB
HTML
955 lines
157 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
|
<html lang="en" class="sidebar-visible no-js light">
|
||
|
|
<head>
|
||
|
|
<!-- Book generated using mdBook -->
|
||
|
|
<meta charset="UTF-8">
|
||
|
|
<title>Rules ForeignCc</title>
|
||
|
|
<meta name="robots" content="noindex" />
|
||
|
|
|
||
|
|
|
||
|
|
<!-- Custom HTML head -->
|
||
|
|
|
||
|
|
|
||
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
||
|
|
<meta name="description" content="">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
|
<meta name="theme-color" content="#ffffff" />
|
||
|
|
|
||
|
|
<link rel="icon" href="favicon.svg">
|
||
|
|
<link rel="shortcut icon" href="favicon.png">
|
||
|
|
<link rel="stylesheet" href="css/variables.css">
|
||
|
|
<link rel="stylesheet" href="css/general.css">
|
||
|
|
<link rel="stylesheet" href="css/chrome.css">
|
||
|
|
<link rel="stylesheet" href="css/print.css" media="print">
|
||
|
|
|
||
|
|
<!-- Fonts -->
|
||
|
|
<link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
|
||
|
|
<link rel="stylesheet" href="fonts/fonts.css">
|
||
|
|
|
||
|
|
<!-- Highlight.js Stylesheets -->
|
||
|
|
<link rel="stylesheet" href="highlight.css">
|
||
|
|
<link rel="stylesheet" href="tomorrow-night.css">
|
||
|
|
<link rel="stylesheet" href="ayu-highlight.css">
|
||
|
|
|
||
|
|
<!-- Custom theme stylesheets -->
|
||
|
|
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<!-- Provide site root to javascript -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var path_to_root = "";
|
||
|
|
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
try {
|
||
|
|
var theme = localStorage.getItem('mdbook-theme');
|
||
|
|
var sidebar = localStorage.getItem('mdbook-sidebar');
|
||
|
|
|
||
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
||
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
||
|
|
}
|
||
|
|
|
||
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
||
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
||
|
|
}
|
||
|
|
} catch (e) { }
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var theme;
|
||
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
||
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
||
|
|
var html = document.querySelector('html');
|
||
|
|
html.classList.remove('no-js')
|
||
|
|
html.classList.remove('light')
|
||
|
|
html.classList.add(theme);
|
||
|
|
html.classList.add('js');
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var html = document.querySelector('html');
|
||
|
|
var sidebar = 'hidden';
|
||
|
|
if (document.body.clientWidth >= 1080) {
|
||
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
||
|
|
sidebar = sidebar || 'visible';
|
||
|
|
}
|
||
|
|
html.classList.remove('sidebar-visible');
|
||
|
|
html.classList.add("sidebar-" + sidebar);
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
||
|
|
<div class="sidebar-scrollbox">
|
||
|
|
<ol class="chapter"><li class="chapter-item expanded "><a href="index.html"><strong aria-hidden="true">1.</strong> Rules ForeignCc</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="rules.html"><strong aria-hidden="true">1.1.</strong> Rules</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="cmake.html"><strong aria-hidden="true">1.1.1.</strong> cmake</a></li><li class="chapter-item expanded "><a href="configure_make.html"><strong aria-hidden="true">1.1.2.</strong> configure_make</a></li><li class="chapter-item expanded "><a href="make.html"><strong aria-hidden="true">1.1.3.</strong> make</a></li><li class="chapter-item expanded "><a href="ninja.html"><strong aria-hidden="true">1.1.4.</strong> ninja</a></li></ol></li></ol></li><li class="chapter-item expanded "><a href="flatten.html"><strong aria-hidden="true">2.</strong> Full API</a></li></ol> </div>
|
||
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<div id="page-wrapper" class="page-wrapper">
|
||
|
|
|
||
|
|
<div class="page">
|
||
|
|
|
||
|
|
<div id="menu-bar-hover-placeholder"></div>
|
||
|
|
<div id="menu-bar" class="menu-bar sticky bordered">
|
||
|
|
<div class="left-buttons">
|
||
|
|
<button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
||
|
|
<i class="fa fa-bars"></i>
|
||
|
|
</button>
|
||
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
||
|
|
<i class="fa fa-paint-brush"></i>
|
||
|
|
</button>
|
||
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light (default)</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
||
|
|
</ul>
|
||
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
|
||
|
|
<i class="fa fa-search"></i>
|
||
|
|
</button>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<h1 class="menu-title">Rules ForeignCc</h1>
|
||
|
|
|
||
|
|
<div class="right-buttons">
|
||
|
|
<a href="print.html" title="Print this book" aria-label="Print this book">
|
||
|
|
<i id="print-button" class="fa fa-print"></i>
|
||
|
|
</a>
|
||
|
|
<a href="https://github.com/bazelbuild/rules_foreign_cc" title="Git repository" aria-label="Git repository">
|
||
|
|
<i id="git-repository-button" class="fa fa-github"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="search-wrapper" class="hidden">
|
||
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
||
|
|
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
||
|
|
</form>
|
||
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
||
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
||
|
|
<ul id="searchresults">
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
||
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
||
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
||
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
||
|
|
});
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<div id="content" class="content">
|
||
|
|
<main>
|
||
|
|
<h1 id="rules-foreigncc"><a class="header" href="#rules-foreigncc">Rules ForeignCc</a></h1>
|
||
|
|
<p>Rules for building C/C++ projects using foreign build systems (non Bazel) inside Bazel projects.</p>
|
||
|
|
<table><thead><tr><th>Release</th><th>Commit</th><th>Status</th></tr></thead><tbody>
|
||
|
|
<tr><td>0.7.0</td><td><a href="https://github.com/bazelbuild/rules_foreign_cc/commit/ae4ff42901354e2da8285dac4be8329eea2ea96a">ae4ff42</a></td><td><a href="https://buildkite.com/bazel/rules-foreign-cc/builds?branch=main"><img src="https://badge.buildkite.com/c28afbf846e2077715c753dda1f4b820cdcc46cc6cde16503c.svg?branch=main" alt="Build status" /></a></td></tr>
|
||
|
|
</tbody></table>
|
||
|
|
<h2 id="overview"><a class="header" href="#overview">Overview</a></h2>
|
||
|
|
<p>Rules ForeignCc is designed to help users build projects that are not built by Bazel and also
|
||
|
|
not fully under their control (ie: large and mature open source software). These rules provide
|
||
|
|
a mechanism to build these external projects within Bazel's sandbox environment using a variety
|
||
|
|
of C/C++ build systems to be later consumed by other rules as though they were normal <a href="https://docs.bazel.build/versions/master/be/c-cpp.html">cc</a>
|
||
|
|
rules.</p>
|
||
|
|
<h2 id="setup"><a class="header" href="#setup">Setup</a></h2>
|
||
|
|
<p>To use the ForeignCc build rules, add the following content to your WORKSPACE file:</p>
|
||
|
|
<pre><code class="language-python">load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
|
||
|
|
|
||
|
|
http_archive(
|
||
|
|
name = "rules_foreign_cc",
|
||
|
|
# TODO: Get the latest sha256 value from a bazel debug message or the latest
|
||
|
|
# release on the releases page: https://github.com/bazelbuild/rules_foreign_cc/releases
|
||
|
|
#
|
||
|
|
# sha256 = "...",
|
||
|
|
strip_prefix = "rules_foreign_cc-0.7.0",
|
||
|
|
url = "https://github.com/bazelbuild/rules_foreign_cc/archive/0.7.0.tar.gz",
|
||
|
|
)
|
||
|
|
|
||
|
|
load("@rules_foreign_cc//foreign_cc:repositories.bzl", "rules_foreign_cc_dependencies")
|
||
|
|
|
||
|
|
rules_foreign_cc_dependencies()
|
||
|
|
</code></pre>
|
||
|
|
<p>Please note that there are many different configuration options for
|
||
|
|
<a href="./flatten.html#rules_foreign_cc_dependencies">rules_foreign_cc_dependencies</a>
|
||
|
|
which offer more control over the toolchains used during the build phase. Please see
|
||
|
|
that macro's documentation for more details.</p>
|
||
|
|
<div style="break-before: page; page-break-before: always;"></div><h1 id="rules"><a class="header" href="#rules">Rules</a></h1>
|
||
|
|
<ul>
|
||
|
|
<li><a href="./cmake.html">cmake</a></li>
|
||
|
|
<li><a href="./configure_make.html">configure_make</a></li>
|
||
|
|
<li><a href="./make.html">make</a></li>
|
||
|
|
<li><a href="./ninja.html">ninja</a></li>
|
||
|
|
</ul>
|
||
|
|
<p>For additional rules/macros/providers, see the <a href="./flatten.html">full API in one page</a>.</p>
|
||
|
|
<div style="break-before: page; page-break-before: always;"></div><!-- Generated with Stardoc: http://skydoc.bazel.build -->
|
||
|
|
<h1 id="a-hrefcmakehtmlcmakecmakea"><a class="header" href="#a-hrefcmakehtmlcmakecmakea"><a href="cmake.html#cmake">CMake</a></a></h1>
|
||
|
|
<h2 id="building-cmake-projects"><a class="header" href="#building-cmake-projects">Building CMake projects</a></h2>
|
||
|
|
<ul>
|
||
|
|
<li>Build libraries/binaries with CMake from sources using cmake rule</li>
|
||
|
|
<li>Use cmake targets in <a href="https://docs.bazel.build/versions/master/be/c-cpp.html#cc_library">cc_library</a>, <a href="https://docs.bazel.build/versions/master/be/c-cpp.html#cc_binary">cc_binary</a> targets as dependency</li>
|
||
|
|
<li>Bazel <a href="https://docs.bazel.build/versions/master/be/c-cpp.html#cc_toolchain">cc_toolchain</a> parameters are used inside cmake build</li>
|
||
|
|
<li>See full list of cmake arguments below 'example'</li>
|
||
|
|
<li>Works on Ubuntu, Mac OS and Windows (<em>see special notes below in Windows section</em>) operating systems</li>
|
||
|
|
</ul>
|
||
|
|
<p><strong>Example:</strong>
|
||
|
|
(Please see full examples in ./examples)</p>
|
||
|
|
<p>The example for <strong>Windows</strong> is below, in the section 'Usage on Windows'.</p>
|
||
|
|
<ul>
|
||
|
|
<li>In <code>WORKSPACE.bazel</code>, we use a <code>http_archive</code> to download tarballs with the libraries we use.</li>
|
||
|
|
<li>In <code>BUILD.bazel</code>, we instantiate a <code>cmake</code> rule which behaves similarly to a <a href="https://docs.bazel.build/versions/master/be/c-cpp.html#cc_library">cc_library</a>, which can then be used in a C++ rule (<a href="https://docs.bazel.build/versions/master/be/c-cpp.html#cc_binary">cc_binary</a> in this case).</li>
|
||
|
|
</ul>
|
||
|
|
<p>In <code>WORKSPACE.bazel</code>, put</p>
|
||
|
|
<pre><code class="language-python">workspace(name = "rules_foreign_cc_usage_example")
|
||
|
|
|
||
|
|
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
|
||
|
|
|
||
|
|
# Rule repository, note that it's recommended to use a pinned commit to a released version of the rules
|
||
|
|
http_archive(
|
||
|
|
name = "rules_foreign_cc",
|
||
|
|
sha256 = "c2cdcf55ffaf49366725639e45dedd449b8c3fe22b54e31625eb80ce3a240f1e",
|
||
|
|
strip_prefix = "rules_foreign_cc-0.1.0",
|
||
|
|
url = "https://github.com/bazelbuild/rules_foreign_cc/archive/0.1.0.zip",
|
||
|
|
)
|
||
|
|
|
||
|
|
load("@rules_foreign_cc//foreign_cc:repositories.bzl", "rules_foreign_cc_dependencies")
|
||
|
|
|
||
|
|
# This sets up some common toolchains for building targets. For more details, please see
|
||
|
|
# https://github.com/bazelbuild/rules_foreign_cc/tree/main/docs#rules_foreign_cc_dependencies
|
||
|
|
rules_foreign_cc_dependencies()
|
||
|
|
|
||
|
|
_ALL_CONTENT = """\
|
||
|
|
filegroup(
|
||
|
|
name = "all_srcs",
|
||
|
|
srcs = glob(["**"]),
|
||
|
|
visibility = ["//visibility:public"],
|
||
|
|
)
|
||
|
|
"""
|
||
|
|
|
||
|
|
# pcre source code repository
|
||
|
|
http_archive(
|
||
|
|
name = "pcre",
|
||
|
|
build_file_content = _ALL_CONTENT,
|
||
|
|
strip_prefix = "pcre-8.43",
|
||
|
|
urls = [
|
||
|
|
"https://mirror.bazel.build/ftp.pcre.org/pub/pcre/pcre-8.43.tar.gz",
|
||
|
|
"https://ftp.pcre.org/pub/pcre/pcre-8.43.tar.gz",
|
||
|
|
],
|
||
|
|
sha256 = "0b8e7465dc5e98c757cc3650a20a7843ee4c3edf50aaf60bb33fd879690d2c73",
|
||
|
|
)
|
||
|
|
</code></pre>
|
||
|
|
<p>And in the <code>BUILD.bazel</code> file, put:</p>
|
||
|
|
<pre><code class="language-python">load("@rules_foreign_cc//foreign_cc:defs.bzl", "cmake")
|
||
|
|
|
||
|
|
cmake(
|
||
|
|
name = "pcre",
|
||
|
|
cache_entries = {
|
||
|
|
"CMAKE_C_FLAGS": "-fPIC",
|
||
|
|
},
|
||
|
|
lib_source = "@pcre//:all_srcs",
|
||
|
|
out_static_libs = ["libpcre.a"],
|
||
|
|
)
|
||
|
|
</code></pre>
|
||
|
|
<p>then build as usual:</p>
|
||
|
|
<pre><code class="language-bash">bazel build //:pcre
|
||
|
|
</code></pre>
|
||
|
|
<p><strong>Usage on Windows</strong></p>
|
||
|
|
<p>When using on Windows, you should start Bazel in MSYS2 shell, as the shell script inside cmake assumes this.
|
||
|
|
Also, you should explicitly specify <strong>make commands and option to generate CMake crosstool file</strong>.</p>
|
||
|
|
<p>The default generator for CMake will be detected automatically, or you can specify it explicitly.</p>
|
||
|
|
<p><strong>The tested generators:</strong> Visual Studio 15, Ninja and NMake.
|
||
|
|
The extension <code>.lib</code> is assumed for the static libraries by default.</p>
|
||
|
|
<p>Example usage (see full example in <code>./examples/cmake_hello_world_lib</code>):
|
||
|
|
Example assumes that MS Visual Studio and Ninja are installed on the host machine, and Ninja bin directory is added to PATH.</p>
|
||
|
|
<pre><code class="language-python">cmake(
|
||
|
|
# expect to find ./lib/hello.lib as the result of the build
|
||
|
|
name = "hello",
|
||
|
|
# This option can be omitted
|
||
|
|
generate_args = [
|
||
|
|
"-G \"Visual Studio 16 2019\"",
|
||
|
|
"-A Win64",
|
||
|
|
],
|
||
|
|
lib_source = ":srcs",
|
||
|
|
)
|
||
|
|
|
||
|
|
cmake(
|
||
|
|
name = "hello_ninja",
|
||
|
|
# expect to find ./lib/hello.lib as the result of the build
|
||
|
|
lib_name = "hello",
|
||
|
|
# explicitly specify the generator
|
||
|
|
generate_args = ["-GNinja"],
|
||
|
|
lib_source = ":srcs",
|
||
|
|
)
|
||
|
|
|
||
|
|
cmake(
|
||
|
|
name = "hello_nmake",
|
||
|
|
# explicitly specify the generator
|
||
|
|
generate_args = ["-G \"NMake Makefiles\""],
|
||
|
|
lib_source = ":srcs",
|
||
|
|
# expect to find ./lib/hello.lib as the result of the build
|
||
|
|
out_static_libs = ["hello.lib"],
|
||
|
|
)
|
||
|
|
</code></pre>
|
||
|
|
<p><a id="#cmake"></a></p>
|
||
|
|
<h2 id="cmake"><a class="header" href="#cmake">cmake</a></h2>
|
||
|
|
<pre>
|
||
|
|
cmake(<a href="cmake.html#cmake-name">name</a>, <a href="cmake.html#cmake-additional_inputs">additional_inputs</a>, <a href="cmake.html#cmake-additional_tools">additional_tools</a>, <a href="cmake.html#cmake-alwayslink">alwayslink</a>, <a href="cmake.html#cmake-build_args">build_args</a>, <a href="cmake.html#cmake-build_data">build_data</a>, <a href="cmake.html#cmake-cache_entries">cache_entries</a>,
|
||
|
|
<a href="cmake.html#cmake-copts">copts</a>, <a href="cmake.html#cmake-data">data</a>, <a href="cmake.html#cmake-defines">defines</a>, <a href="cmake.html#cmake-deps">deps</a>, <a href="cmake.html#cmake-env">env</a>, <a href="cmake.html#cmake-generate_args">generate_args</a>, <a href="cmake.html#cmake-generate_crosstool_file">generate_crosstool_file</a>, <a href="cmake.html#cmake-includes">includes</a>, <a href="cmake.html#cmake-install">install</a>,
|
||
|
|
<a href="cmake.html#cmake-install_args">install_args</a>, <a href="cmake.html#cmake-lib_name">lib_name</a>, <a href="cmake.html#cmake-lib_source">lib_source</a>, <a href="cmake.html#cmake-linkopts">linkopts</a>, <a href="cmake.html#cmake-out_bin_dir">out_bin_dir</a>, <a href="cmake.html#cmake-out_binaries">out_binaries</a>, <a href="cmake.html#cmake-out_data_dirs">out_data_dirs</a>,
|
||
|
|
<a href="cmake.html#cmake-out_headers_only">out_headers_only</a>, <a href="cmake.html#cmake-out_include_dir">out_include_dir</a>, <a href="cmake.html#cmake-out_interface_libs">out_interface_libs</a>, <a href="cmake.html#cmake-out_lib_dir">out_lib_dir</a>, <a href="cmake.html#cmake-out_shared_libs">out_shared_libs</a>,
|
||
|
|
<a href="cmake.html#cmake-out_static_libs">out_static_libs</a>, <a href="cmake.html#cmake-postfix_script">postfix_script</a>, <a href="cmake.html#cmake-targets">targets</a>, <a href="cmake.html#cmake-tool_prefix">tool_prefix</a>, <a href="cmake.html#cmake-tools_deps">tools_deps</a>, <a href="cmake.html#cmake-working_directory">working_directory</a>)
|
||
|
|
</pre>
|
||
|
|
<p>Rule for building external library with CMake.</p>
|
||
|
|
<p><strong>ATTRIBUTES</strong></p>
|
||
|
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||
|
|
<tr><td align="left"><a id="cmake-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-additional_inputs"></a>additional_inputs</td><td align="left"><strong>deprecated</strong>: Please use the <code>build_data</code> attribute.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-additional_tools"></a>additional_tools</td><td align="left"><strong>deprecated</strong>: Please use the <code>build_data</code> attribute.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-alwayslink"></a>alwayslink</td><td align="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-build_args"></a>build_args</td><td align="left">Arguments for the CMake build command</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-build_data"></a>build_data</td><td align="left">Files needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-cache_entries"></a>cache_entries</td><td align="left">CMake cache entries to initialize (they will be passed with <code>-Dkey=value</code>) Values, defined by the toolchain, will be joined with the values, passed here. (Toolchain values come first)</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-copts"></a>copts</td><td align="left">Optional. Add these options to the compile flags passed to the foreign build system. The flags only take affect for compiling this target, not its dependencies.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-data"></a>data</td><td align="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-defines"></a>defines</td><td align="left">Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-deps"></a>deps</td><td align="left">Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external build system will be looking for and paths to which are provided by the calling rule)</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-env"></a>env</td><td align="left">Environment variables to set during the build. <code>$(execpath)</code> macros may be used to point at files which are listed as <code>data</code>, <code>deps</code>, or <code>build_data</code>, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. This attribute is subject to make variable substitution. No other macros are supported.Variables containing <code>PATH</code> (e.g. <code>PATH</code>, <code>LD_LIBRARY_PATH</code>, <code>CPATH</code>) entries will be prepended to the existing variable.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-generate_args"></a>generate_args</td><td align="left">Arguments for CMake's generate command. Arguments should be passed as key/value pairs. eg: <code>["-G Ninja", "--debug-output", "-DFOO=bar"]</code>. Note that unless a generator (<code>-G</code>) argument is provided, the default generators are <a href="https://cmake.org/cmake/help/latest/generator/Unix%20Makefiles.html">Unix Makefiles</a> for Linux and MacOS and <a href="https://cmake.org/cmake/help/latest/generator/Ninja.html">Ninja</a> for Windows.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-generate_crosstool_file"></a>generate_crosstool_file</td><td align="left">When True, CMake crosstool file will be generated from the toolchain values, provided cache-entries and env_vars (some values will still be passed as <code>-Dkey=value</code> and environment variables). If <code>CMAKE_TOOLCHAIN_FILE</code> cache entry is passed, specified crosstool file will be used When using this option to cross-compile, it is required to specify <code>CMAKE_SYSTEM_NAME</code> in the cache_entries</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">True</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-includes"></a>includes</td><td align="left">Optional list of include dirs to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-install"></a>install</td><td align="left">If True, the <code>cmake --install</code> comand will be performed after a build</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">True</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-install_args"></a>install_args</td><td align="left">Arguments for the CMake install command</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-lib_name"></a>lib_name</td><td align="left">Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-lib_source"></a>lib_source</td><td align="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-linkopts"></a>linkopts</td><td align="left">Optional link options to be passed up to the dependencies of this library</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-out_bin_dir"></a>out_bin_dir</td><td align="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"bin"</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-out_binaries"></a>out_binaries</td><td align="left">Optional names of the resulting binaries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-out_data_dirs"></a>out_data_dirs</td><td align="left">Optional names of additional directories created by the build that should be declared as bazel action outputs</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-out_headers_only"></a>out_headers_only</td><td align="left">Flag variable to indicate that the library produces only headers</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-out_include_dir"></a>out_include_dir</td><td align="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"include"</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-out_interface_libs"></a>out_interface_libs</td><td align="left">Optional names of the resulting interface libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-out_lib_dir"></a>out_lib_dir</td><td align="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"lib"</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-out_shared_libs"></a>out_shared_libs</td><td align="left">Optional names of the resulting shared libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-out_static_libs"></a>out_static_libs</td><td align="left">Optional names of the resulting static libraries. Note that if <code>out_headers_only</code>, <code>out_static_libs</code>, <code>out_shared_libs</code>, and <code>out_binaries</code> are not set, default <code>lib_name.a</code>/<code>lib_name.lib</code> static library is assumed</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-postfix_script"></a>postfix_script</td><td align="left">Optional part of the shell script to be added after the make commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-targets"></a>targets</td><td align="left">A list of targets with in the foreign build system to produce. An empty string (<code>""</code>) will result in a call to the underlying build system with no explicit target set</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-tool_prefix"></a>tool_prefix</td><td align="left">A prefix for build commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-tools_deps"></a>tools_deps</td><td align="left"><strong>deprecated</strong>: Please use the <code>build_data</code> attribute.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-working_directory"></a>working_directory</td><td align="left">Working directory, with the main CMakeLists.txt (otherwise, the top directory of the lib_source label files is used.)</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
</tbody></table>
|
||
|
|
<p><a id="#cmake_variant"></a></p>
|
||
|
|
<h2 id="cmake_variant"><a class="header" href="#cmake_variant">cmake_variant</a></h2>
|
||
|
|
<pre>
|
||
|
|
cmake_variant(<a href="cmake.html#cmake_variant-name">name</a>, <a href="cmake.html#cmake_variant-toolchain">toolchain</a>, <a href="cmake.html#cmake_variant-kwargs">kwargs</a>)
|
||
|
|
</pre>
|
||
|
|
<p>Wrapper macro around the cmake() rule to force usage of the given make variant toolchain.</p>
|
||
|
|
<p><strong>PARAMETERS</strong></p>
|
||
|
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Default Value</th></tr></thead><tbody>
|
||
|
|
<tr><td align="left"><a id="cmake_variant-name"></a>name</td><td align="left">The target name</td><td align="left">none</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake_variant-toolchain"></a>toolchain</td><td align="left">The desired make variant toolchain to use, e.g. @rules_foreign_cc//toolchains:preinstalled_nmake_toolchain</td><td align="left">none</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake_variant-kwargs"></a>kwargs</td><td align="left">Remaining keyword arguments</td><td align="left">none</td></tr>
|
||
|
|
</tbody></table>
|
||
|
|
<div style="break-before: page; page-break-before: always;"></div><!-- Generated with Stardoc: http://skydoc.bazel.build -->
|
||
|
|
<p>A rule for building projects using the <a href="https://www.gnu.org/prep/standards/html_node/Configuration.html">Configure+Make</a>
|
||
|
|
build tool</p>
|
||
|
|
<p><a id="#configure_make"></a></p>
|
||
|
|
<h2 id="configure_make"><a class="header" href="#configure_make">configure_make</a></h2>
|
||
|
|
<pre>
|
||
|
|
configure_make(<a href="configure_make.html#configure_make-name">name</a>, <a href="configure_make.html#configure_make-additional_inputs">additional_inputs</a>, <a href="configure_make.html#configure_make-additional_tools">additional_tools</a>, <a href="configure_make.html#configure_make-alwayslink">alwayslink</a>, <a href="configure_make.html#configure_make-args">args</a>, <a href="configure_make.html#configure_make-autoconf">autoconf</a>,
|
||
|
|
<a href="configure_make.html#configure_make-autoconf_options">autoconf_options</a>, <a href="configure_make.html#configure_make-autogen">autogen</a>, <a href="configure_make.html#configure_make-autogen_command">autogen_command</a>, <a href="configure_make.html#configure_make-autogen_options">autogen_options</a>, <a href="configure_make.html#configure_make-autoreconf">autoreconf</a>,
|
||
|
|
<a href="configure_make.html#configure_make-autoreconf_options">autoreconf_options</a>, <a href="configure_make.html#configure_make-build_data">build_data</a>, <a href="configure_make.html#configure_make-configure_command">configure_command</a>, <a href="configure_make.html#configure_make-configure_in_place">configure_in_place</a>,
|
||
|
|
<a href="configure_make.html#configure_make-configure_options">configure_options</a>, <a href="configure_make.html#configure_make-configure_prefix">configure_prefix</a>, <a href="configure_make.html#configure_make-copts">copts</a>, <a href="configure_make.html#configure_make-data">data</a>, <a href="configure_make.html#configure_make-defines">defines</a>, <a href="configure_make.html#configure_make-deps">deps</a>, <a href="configure_make.html#configure_make-env">env</a>, <a href="configure_make.html#configure_make-includes">includes</a>,
|
||
|
|
<a href="configure_make.html#configure_make-install_prefix">install_prefix</a>, <a href="configure_make.html#configure_make-lib_name">lib_name</a>, <a href="configure_make.html#configure_make-lib_source">lib_source</a>, <a href="configure_make.html#configure_make-linkopts">linkopts</a>, <a href="configure_make.html#configure_make-out_bin_dir">out_bin_dir</a>, <a href="configure_make.html#configure_make-out_binaries">out_binaries</a>,
|
||
|
|
<a href="configure_make.html#configure_make-out_data_dirs">out_data_dirs</a>, <a href="configure_make.html#configure_make-out_headers_only">out_headers_only</a>, <a href="configure_make.html#configure_make-out_include_dir">out_include_dir</a>, <a href="configure_make.html#configure_make-out_interface_libs">out_interface_libs</a>, <a href="configure_make.html#configure_make-out_lib_dir">out_lib_dir</a>,
|
||
|
|
<a href="configure_make.html#configure_make-out_shared_libs">out_shared_libs</a>, <a href="configure_make.html#configure_make-out_static_libs">out_static_libs</a>, <a href="configure_make.html#configure_make-postfix_script">postfix_script</a>, <a href="configure_make.html#configure_make-targets">targets</a>, <a href="configure_make.html#configure_make-tool_prefix">tool_prefix</a>, <a href="configure_make.html#configure_make-tools_deps">tools_deps</a>)
|
||
|
|
</pre>
|
||
|
|
<p>Rule for building external libraries with configure-make pattern. Some 'configure' script is invoked with --prefix=install (by default), and other parameters for compilation and linking, taken from Bazel C/C++ toolchain and passed dependencies. After configuration, GNU Make is called.</p>
|
||
|
|
<p><strong>ATTRIBUTES</strong></p>
|
||
|
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||
|
|
<tr><td align="left"><a id="configure_make-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-additional_inputs"></a>additional_inputs</td><td align="left"><strong>deprecated</strong>: Please use the <code>build_data</code> attribute.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-additional_tools"></a>additional_tools</td><td align="left"><strong>deprecated</strong>: Please use the <code>build_data</code> attribute.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-alwayslink"></a>alwayslink</td><td align="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-args"></a>args</td><td align="left">A list of arguments to pass to the call to <code>make</code></td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-autoconf"></a>autoconf</td><td align="left">Set to True if 'autoconf' should be invoked before 'configure', currently requires <code>configure_in_place</code> to be True.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-autoconf_options"></a>autoconf_options</td><td align="left">Any options to be put in the 'autoconf.sh' command line.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-autogen"></a>autogen</td><td align="left">Set to True if 'autogen.sh' should be invoked before 'configure', currently requires <code>configure_in_place</code> to be True.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-autogen_command"></a>autogen_command</td><td align="left">The name of the autogen script file, default: autogen.sh. Many projects use autogen.sh however the Autotools FAQ recommends bootstrap so we provide this option to support that.</td><td align="left">String</td><td align="left">optional</td><td align="left">"autogen.sh"</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-autogen_options"></a>autogen_options</td><td align="left">Any options to be put in the 'autogen.sh' command line.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-autoreconf"></a>autoreconf</td><td align="left">Set to True if 'autoreconf' should be invoked before 'configure.', currently requires <code>configure_in_place</code> to be True.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-autoreconf_options"></a>autoreconf_options</td><td align="left">Any options to be put in the 'autoreconf.sh' command line.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-build_data"></a>build_data</td><td align="left">Files needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-configure_command"></a>configure_command</td><td align="left">The name of the configuration script file, default: configure. The file must be in the root of the source directory.</td><td align="left">String</td><td align="left">optional</td><td align="left">"configure"</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-configure_in_place"></a>configure_in_place</td><td align="left">Set to True if 'configure' should be invoked in place, i.e. from its enclosing directory.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-configure_options"></a>configure_options</td><td align="left">Any options to be put on the 'configure' command line.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-configure_prefix"></a>configure_prefix</td><td align="left">A prefix for the call to the <code>configure_command</code>.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-copts"></a>copts</td><td align="left">Optional. Add these options to the compile flags passed to the foreign build system. The flags only take affect for compiling this target, not its dependencies.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-data"></a>data</td><td align="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-defines"></a>defines</td><td align="left">Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-deps"></a>deps</td><td align="left">Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external build system will be looking for and paths to which are provided by the calling rule)</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-env"></a>env</td><td align="left">Environment variables to set during the build. <code>$(execpath)</code> macros may be used to point at files which are listed as <code>data</code>, <code>deps</code>, or <code>build_data</code>, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. This attribute is subject to make variable substitution. No other macros are supported.Variables containing <code>PATH</code> (e.g. <code>PATH</code>, <code>LD_LIBRARY_PATH</code>, <code>CPATH</code>) entries will be prepended to the existing variable.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-includes"></a>includes</td><td align="left">Optional list of include dirs to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-install_prefix"></a>install_prefix</td><td align="left">Install prefix, i.e. relative path to where to install the result of the build. Passed to the 'configure' script with --prefix flag.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-lib_name"></a>lib_name</td><td align="left">Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-lib_source"></a>lib_source</td><td align="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-linkopts"></a>linkopts</td><td align="left">Optional link options to be passed up to the dependencies of this library</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-out_bin_dir"></a>out_bin_dir</td><td align="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"bin"</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-out_binaries"></a>out_binaries</td><td align="left">Optional names of the resulting binaries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-out_data_dirs"></a>out_data_dirs</td><td align="left">Optional names of additional directories created by the build that should be declared as bazel action outputs</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-out_headers_only"></a>out_headers_only</td><td align="left">Flag variable to indicate that the library produces only headers</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-out_include_dir"></a>out_include_dir</td><td align="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"include"</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-out_interface_libs"></a>out_interface_libs</td><td align="left">Optional names of the resulting interface libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-out_lib_dir"></a>out_lib_dir</td><td align="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"lib"</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-out_shared_libs"></a>out_shared_libs</td><td align="left">Optional names of the resulting shared libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-out_static_libs"></a>out_static_libs</td><td align="left">Optional names of the resulting static libraries. Note that if <code>out_headers_only</code>, <code>out_static_libs</code>, <code>out_shared_libs</code>, and <code>out_binaries</code> are not set, default <code>lib_name.a</code>/<code>lib_name.lib</code> static library is assumed</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-postfix_script"></a>postfix_script</td><td align="left">Optional part of the shell script to be added after the make commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-targets"></a>targets</td><td align="left">A list of targets within the foreign build system to produce. An empty string (<code>""</code>) will result in a call to the underlying build system with no explicit target set</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">["", "install"]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-tool_prefix"></a>tool_prefix</td><td align="left">A prefix for build commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-tools_deps"></a>tools_deps</td><td align="left"><strong>deprecated</strong>: Please use the <code>build_data</code> attribute.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
</tbody></table>
|
||
|
|
<p><a id="#configure_make_variant"></a></p>
|
||
|
|
<h2 id="configure_make_variant"><a class="header" href="#configure_make_variant">configure_make_variant</a></h2>
|
||
|
|
<pre>
|
||
|
|
configure_make_variant(<a href="configure_make.html#configure_make_variant-name">name</a>, <a href="configure_make.html#configure_make_variant-toolchain">toolchain</a>, <a href="configure_make.html#configure_make_variant-kwargs">kwargs</a>)
|
||
|
|
</pre>
|
||
|
|
<p>Wrapper macro around the configure_make() rule to force usage of the given make variant toolchain.</p>
|
||
|
|
<p><strong>PARAMETERS</strong></p>
|
||
|
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Default Value</th></tr></thead><tbody>
|
||
|
|
<tr><td align="left"><a id="configure_make_variant-name"></a>name</td><td align="left">The target name</td><td align="left">none</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make_variant-toolchain"></a>toolchain</td><td align="left">The desired make variant toolchain to use, e.g. @rules_foreign_cc//toolchains:preinstalled_nmake_toolchain</td><td align="left">none</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make_variant-kwargs"></a>kwargs</td><td align="left">Remaining keyword arguments</td><td align="left">none</td></tr>
|
||
|
|
</tbody></table>
|
||
|
|
<div style="break-before: page; page-break-before: always;"></div><!-- Generated with Stardoc: http://skydoc.bazel.build -->
|
||
|
|
<p>A rule for building projects using the <a href="https://www.gnu.org/software/make/">GNU Make</a> build tool</p>
|
||
|
|
<p><a id="#make"></a></p>
|
||
|
|
<h2 id="make"><a class="header" href="#make">make</a></h2>
|
||
|
|
<pre>
|
||
|
|
make(<a href="make.html#make-name">name</a>, <a href="make.html#make-additional_inputs">additional_inputs</a>, <a href="make.html#make-additional_tools">additional_tools</a>, <a href="make.html#make-alwayslink">alwayslink</a>, <a href="make.html#make-args">args</a>, <a href="make.html#make-build_data">build_data</a>, <a href="make.html#make-copts">copts</a>, <a href="make.html#make-data">data</a>, <a href="make.html#make-defines">defines</a>,
|
||
|
|
<a href="make.html#make-deps">deps</a>, <a href="make.html#make-env">env</a>, <a href="make.html#make-includes">includes</a>, <a href="make.html#make-install_prefix">install_prefix</a>, <a href="make.html#make-lib_name">lib_name</a>, <a href="make.html#make-lib_source">lib_source</a>, <a href="make.html#make-linkopts">linkopts</a>, <a href="make.html#make-out_bin_dir">out_bin_dir</a>, <a href="make.html#make-out_binaries">out_binaries</a>,
|
||
|
|
<a href="make.html#make-out_data_dirs">out_data_dirs</a>, <a href="make.html#make-out_headers_only">out_headers_only</a>, <a href="make.html#make-out_include_dir">out_include_dir</a>, <a href="make.html#make-out_interface_libs">out_interface_libs</a>, <a href="make.html#make-out_lib_dir">out_lib_dir</a>,
|
||
|
|
<a href="make.html#make-out_shared_libs">out_shared_libs</a>, <a href="make.html#make-out_static_libs">out_static_libs</a>, <a href="make.html#make-postfix_script">postfix_script</a>, <a href="make.html#make-targets">targets</a>, <a href="make.html#make-tool_prefix">tool_prefix</a>, <a href="make.html#make-tools_deps">tools_deps</a>)
|
||
|
|
</pre>
|
||
|
|
<p>Rule for building external libraries with GNU Make. GNU Make commands (make and make install by default) are invoked with PREFIX="install" (by default), and other environment variables for compilation and linking, taken from Bazel C/C++ toolchain and passed dependencies.</p>
|
||
|
|
<p><strong>ATTRIBUTES</strong></p>
|
||
|
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||
|
|
<tr><td align="left"><a id="make-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||
|
|
<tr><td align="left"><a id="make-additional_inputs"></a>additional_inputs</td><td align="left"><strong>deprecated</strong>: Please use the <code>build_data</code> attribute.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-additional_tools"></a>additional_tools</td><td align="left"><strong>deprecated</strong>: Please use the <code>build_data</code> attribute.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-alwayslink"></a>alwayslink</td><td align="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-args"></a>args</td><td align="left">A list of arguments to pass to the call to <code>make</code></td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-build_data"></a>build_data</td><td align="left">Files needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-copts"></a>copts</td><td align="left">Optional. Add these options to the compile flags passed to the foreign build system. The flags only take affect for compiling this target, not its dependencies.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-data"></a>data</td><td align="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-defines"></a>defines</td><td align="left">Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-deps"></a>deps</td><td align="left">Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external build system will be looking for and paths to which are provided by the calling rule)</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-env"></a>env</td><td align="left">Environment variables to set during the build. <code>$(execpath)</code> macros may be used to point at files which are listed as <code>data</code>, <code>deps</code>, or <code>build_data</code>, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. This attribute is subject to make variable substitution. No other macros are supported.Variables containing <code>PATH</code> (e.g. <code>PATH</code>, <code>LD_LIBRARY_PATH</code>, <code>CPATH</code>) entries will be prepended to the existing variable.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-includes"></a>includes</td><td align="left">Optional list of include dirs to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-install_prefix"></a>install_prefix</td><td align="left">Install prefix, i.e. relative path to where to install the result of the build. Passed as an arg to "make" as PREFIX=<install_prefix>.</td><td align="left">String</td><td align="left">optional</td><td align="left">"$$INSTALLDIR$$"</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-lib_name"></a>lib_name</td><td align="left">Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-lib_source"></a>lib_source</td><td align="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||
|
|
<tr><td align="left"><a id="make-linkopts"></a>linkopts</td><td align="left">Optional link options to be passed up to the dependencies of this library</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-out_bin_dir"></a>out_bin_dir</td><td align="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"bin"</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-out_binaries"></a>out_binaries</td><td align="left">Optional names of the resulting binaries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-out_data_dirs"></a>out_data_dirs</td><td align="left">Optional names of additional directories created by the build that should be declared as bazel action outputs</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-out_headers_only"></a>out_headers_only</td><td align="left">Flag variable to indicate that the library produces only headers</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-out_include_dir"></a>out_include_dir</td><td align="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"include"</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-out_interface_libs"></a>out_interface_libs</td><td align="left">Optional names of the resulting interface libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-out_lib_dir"></a>out_lib_dir</td><td align="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"lib"</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-out_shared_libs"></a>out_shared_libs</td><td align="left">Optional names of the resulting shared libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-out_static_libs"></a>out_static_libs</td><td align="left">Optional names of the resulting static libraries. Note that if <code>out_headers_only</code>, <code>out_static_libs</code>, <code>out_shared_libs</code>, and <code>out_binaries</code> are not set, default <code>lib_name.a</code>/<code>lib_name.lib</code> static library is assumed</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-postfix_script"></a>postfix_script</td><td align="left">Optional part of the shell script to be added after the make commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-targets"></a>targets</td><td align="left">A list of targets within the foreign build system to produce. An empty string (<code>""</code>) will result in a call to the underlying build system with no explicit target set</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">["", "install"]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-tool_prefix"></a>tool_prefix</td><td align="left">A prefix for build commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-tools_deps"></a>tools_deps</td><td align="left"><strong>deprecated</strong>: Please use the <code>build_data</code> attribute.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
</tbody></table>
|
||
|
|
<p><a id="#make_variant"></a></p>
|
||
|
|
<h2 id="make_variant"><a class="header" href="#make_variant">make_variant</a></h2>
|
||
|
|
<pre>
|
||
|
|
make_variant(<a href="make.html#make_variant-name">name</a>, <a href="make.html#make_variant-toolchain">toolchain</a>, <a href="make.html#make_variant-kwargs">kwargs</a>)
|
||
|
|
</pre>
|
||
|
|
<p>Wrapper macro around the make() rule to force usage of the given make variant toolchain.</p>
|
||
|
|
<p><strong>PARAMETERS</strong></p>
|
||
|
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Default Value</th></tr></thead><tbody>
|
||
|
|
<tr><td align="left"><a id="make_variant-name"></a>name</td><td align="left">The target name</td><td align="left">none</td></tr>
|
||
|
|
<tr><td align="left"><a id="make_variant-toolchain"></a>toolchain</td><td align="left">The desired make variant toolchain to use, e.g. @rules_foreign_cc//toolchains:preinstalled_nmake_toolchain</td><td align="left">none</td></tr>
|
||
|
|
<tr><td align="left"><a id="make_variant-kwargs"></a>kwargs</td><td align="left">Remaining keyword arguments</td><td align="left">none</td></tr>
|
||
|
|
</tbody></table>
|
||
|
|
<div style="break-before: page; page-break-before: always;"></div><!-- Generated with Stardoc: http://skydoc.bazel.build -->
|
||
|
|
<p>A rule for building projects using the <a href="https://ninja-build.org/">Ninja</a> build tool</p>
|
||
|
|
<p><a id="#ninja"></a></p>
|
||
|
|
<h2 id="ninja"><a class="header" href="#ninja">ninja</a></h2>
|
||
|
|
<pre>
|
||
|
|
ninja(<a href="ninja.html#ninja-name">name</a>, <a href="ninja.html#ninja-additional_inputs">additional_inputs</a>, <a href="ninja.html#ninja-additional_tools">additional_tools</a>, <a href="ninja.html#ninja-alwayslink">alwayslink</a>, <a href="ninja.html#ninja-args">args</a>, <a href="ninja.html#ninja-build_data">build_data</a>, <a href="ninja.html#ninja-copts">copts</a>, <a href="ninja.html#ninja-data">data</a>, <a href="ninja.html#ninja-defines">defines</a>,
|
||
|
|
<a href="ninja.html#ninja-deps">deps</a>, <a href="ninja.html#ninja-directory">directory</a>, <a href="ninja.html#ninja-env">env</a>, <a href="ninja.html#ninja-includes">includes</a>, <a href="ninja.html#ninja-lib_name">lib_name</a>, <a href="ninja.html#ninja-lib_source">lib_source</a>, <a href="ninja.html#ninja-linkopts">linkopts</a>, <a href="ninja.html#ninja-out_bin_dir">out_bin_dir</a>, <a href="ninja.html#ninja-out_binaries">out_binaries</a>,
|
||
|
|
<a href="ninja.html#ninja-out_data_dirs">out_data_dirs</a>, <a href="ninja.html#ninja-out_headers_only">out_headers_only</a>, <a href="ninja.html#ninja-out_include_dir">out_include_dir</a>, <a href="ninja.html#ninja-out_interface_libs">out_interface_libs</a>, <a href="ninja.html#ninja-out_lib_dir">out_lib_dir</a>,
|
||
|
|
<a href="ninja.html#ninja-out_shared_libs">out_shared_libs</a>, <a href="ninja.html#ninja-out_static_libs">out_static_libs</a>, <a href="ninja.html#ninja-postfix_script">postfix_script</a>, <a href="ninja.html#ninja-targets">targets</a>, <a href="ninja.html#ninja-tool_prefix">tool_prefix</a>, <a href="ninja.html#ninja-tools_deps">tools_deps</a>)
|
||
|
|
</pre>
|
||
|
|
<p>Rule for building external libraries with <a href="https://ninja-build.org/">Ninja</a>.</p>
|
||
|
|
<p><strong>ATTRIBUTES</strong></p>
|
||
|
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||
|
|
<tr><td align="left"><a id="ninja-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-additional_inputs"></a>additional_inputs</td><td align="left"><strong>deprecated</strong>: Please use the <code>build_data</code> attribute.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-additional_tools"></a>additional_tools</td><td align="left"><strong>deprecated</strong>: Please use the <code>build_data</code> attribute.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-alwayslink"></a>alwayslink</td><td align="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-args"></a>args</td><td align="left">A list of arguments to pass to the call to <code>ninja</code></td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-build_data"></a>build_data</td><td align="left">Files needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-copts"></a>copts</td><td align="left">Optional. Add these options to the compile flags passed to the foreign build system. The flags only take affect for compiling this target, not its dependencies.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-data"></a>data</td><td align="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-defines"></a>defines</td><td align="left">Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-deps"></a>deps</td><td align="left">Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external build system will be looking for and paths to which are provided by the calling rule)</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-directory"></a>directory</td><td align="left">A directory to pass as the <code>-C</code> argument. The rule will always use the root directory of the <code>lib_sources</code> attribute if this attribute is not set</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-env"></a>env</td><td align="left">Environment variables to set during the build. <code>$(execpath)</code> macros may be used to point at files which are listed as <code>data</code>, <code>deps</code>, or <code>build_data</code>, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. This attribute is subject to make variable substitution. No other macros are supported.Variables containing <code>PATH</code> (e.g. <code>PATH</code>, <code>LD_LIBRARY_PATH</code>, <code>CPATH</code>) entries will be prepended to the existing variable.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-includes"></a>includes</td><td align="left">Optional list of include dirs to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-lib_name"></a>lib_name</td><td align="left">Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-lib_source"></a>lib_source</td><td align="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-linkopts"></a>linkopts</td><td align="left">Optional link options to be passed up to the dependencies of this library</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-out_bin_dir"></a>out_bin_dir</td><td align="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"bin"</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-out_binaries"></a>out_binaries</td><td align="left">Optional names of the resulting binaries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-out_data_dirs"></a>out_data_dirs</td><td align="left">Optional names of additional directories created by the build that should be declared as bazel action outputs</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-out_headers_only"></a>out_headers_only</td><td align="left">Flag variable to indicate that the library produces only headers</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-out_include_dir"></a>out_include_dir</td><td align="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"include"</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-out_interface_libs"></a>out_interface_libs</td><td align="left">Optional names of the resulting interface libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-out_lib_dir"></a>out_lib_dir</td><td align="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"lib"</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-out_shared_libs"></a>out_shared_libs</td><td align="left">Optional names of the resulting shared libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-out_static_libs"></a>out_static_libs</td><td align="left">Optional names of the resulting static libraries. Note that if <code>out_headers_only</code>, <code>out_static_libs</code>, <code>out_shared_libs</code>, and <code>out_binaries</code> are not set, default <code>lib_name.a</code>/<code>lib_name.lib</code> static library is assumed</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-postfix_script"></a>postfix_script</td><td align="left">Optional part of the shell script to be added after the make commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-targets"></a>targets</td><td align="left">A list of targets with in the foreign build system to produce. An empty string (<code>""</code>) will result in a call to the underlying build system with no explicit target set</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-tool_prefix"></a>tool_prefix</td><td align="left">A prefix for build commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-tools_deps"></a>tools_deps</td><td align="left"><strong>deprecated</strong>: Please use the <code>build_data</code> attribute.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
</tbody></table>
|
||
|
|
<div style="break-before: page; page-break-before: always;"></div><!-- Generated with Stardoc, Do Not Edit! -->
|
||
|
|
<h1 id="rules-foreign-cc"><a class="header" href="#rules-foreign-cc">Rules Foreign CC</a></h1>
|
||
|
|
<ul>
|
||
|
|
<li><a href="flatten.html#boost_build">boost_build</a></li>
|
||
|
|
<li><a href="flatten.html#cmake">cmake</a></li>
|
||
|
|
<li><a href="flatten.html#cmake_tool">cmake_tool</a></li>
|
||
|
|
<li><a href="flatten.html#cmake_variant">cmake_variant</a></li>
|
||
|
|
<li><a href="flatten.html#configure_make">configure_make</a></li>
|
||
|
|
<li><a href="flatten.html#configure_make_variant">configure_make_variant</a></li>
|
||
|
|
<li><a href="flatten.html#foreignccartifactinfo">ForeignCcArtifactInfo</a></li>
|
||
|
|
<li><a href="flatten.html#foreignccdepsinfo">ForeignCcDepsInfo</a></li>
|
||
|
|
<li><a href="flatten.html#make">make</a></li>
|
||
|
|
<li><a href="flatten.html#make_tool">make_tool</a></li>
|
||
|
|
<li><a href="flatten.html#make_variant">make_variant</a></li>
|
||
|
|
<li><a href="flatten.html#native_tool_toolchain">native_tool_toolchain</a></li>
|
||
|
|
<li><a href="flatten.html#ninja">ninja</a></li>
|
||
|
|
<li><a href="flatten.html#ninja_tool">ninja_tool</a></li>
|
||
|
|
<li><a href="flatten.html#rules_foreign_cc_dependencies">rules_foreign_cc_dependencies</a></li>
|
||
|
|
<li><a href="flatten.html#toolinfo">ToolInfo</a></li>
|
||
|
|
</ul>
|
||
|
|
<p><a id="#boost_build"></a></p>
|
||
|
|
<h2 id="boost_build"><a class="header" href="#boost_build">boost_build</a></h2>
|
||
|
|
<pre>
|
||
|
|
boost_build(<a href="flatten.html#boost_build-name">name</a>, <a href="flatten.html#boost_build-additional_inputs">additional_inputs</a>, <a href="flatten.html#boost_build-additional_tools">additional_tools</a>, <a href="flatten.html#boost_build-alwayslink">alwayslink</a>, <a href="flatten.html#boost_build-bootstrap_options">bootstrap_options</a>, <a href="flatten.html#boost_build-build_data">build_data</a>,
|
||
|
|
<a href="flatten.html#boost_build-copts">copts</a>, <a href="flatten.html#boost_build-data">data</a>, <a href="flatten.html#boost_build-defines">defines</a>, <a href="flatten.html#boost_build-deps">deps</a>, <a href="flatten.html#boost_build-env">env</a>, <a href="flatten.html#boost_build-includes">includes</a>, <a href="flatten.html#boost_build-lib_name">lib_name</a>, <a href="flatten.html#boost_build-lib_source">lib_source</a>, <a href="flatten.html#boost_build-linkopts">linkopts</a>, <a href="flatten.html#boost_build-out_bin_dir">out_bin_dir</a>,
|
||
|
|
<a href="flatten.html#boost_build-out_binaries">out_binaries</a>, <a href="flatten.html#boost_build-out_data_dirs">out_data_dirs</a>, <a href="flatten.html#boost_build-out_headers_only">out_headers_only</a>, <a href="flatten.html#boost_build-out_include_dir">out_include_dir</a>, <a href="flatten.html#boost_build-out_interface_libs">out_interface_libs</a>,
|
||
|
|
<a href="flatten.html#boost_build-out_lib_dir">out_lib_dir</a>, <a href="flatten.html#boost_build-out_shared_libs">out_shared_libs</a>, <a href="flatten.html#boost_build-out_static_libs">out_static_libs</a>, <a href="flatten.html#boost_build-postfix_script">postfix_script</a>, <a href="flatten.html#boost_build-tool_prefix">tool_prefix</a>, <a href="flatten.html#boost_build-tools_deps">tools_deps</a>,
|
||
|
|
<a href="flatten.html#boost_build-user_options">user_options</a>)
|
||
|
|
</pre>
|
||
|
|
<p>Rule for building Boost. Invokes bootstrap.sh and then b2 install.</p>
|
||
|
|
<p><strong>ATTRIBUTES</strong></p>
|
||
|
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||
|
|
<tr><td align="left"><a id="boost_build-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||
|
|
<tr><td align="left"><a id="boost_build-additional_inputs"></a>additional_inputs</td><td align="left"><strong>deprecated</strong>: Please use the <code>build_data</code> attribute.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="boost_build-additional_tools"></a>additional_tools</td><td align="left"><strong>deprecated</strong>: Please use the <code>build_data</code> attribute.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="boost_build-alwayslink"></a>alwayslink</td><td align="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||
|
|
<tr><td align="left"><a id="boost_build-bootstrap_options"></a>bootstrap_options</td><td align="left">any additional flags to pass to bootstrap.sh</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="boost_build-build_data"></a>build_data</td><td align="left">Files needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="boost_build-copts"></a>copts</td><td align="left">Optional. Add these options to the compile flags passed to the foreign build system. The flags only take affect for compiling this target, not its dependencies.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="boost_build-data"></a>data</td><td align="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="boost_build-defines"></a>defines</td><td align="left">Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="boost_build-deps"></a>deps</td><td align="left">Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external build system will be looking for and paths to which are provided by the calling rule)</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="boost_build-env"></a>env</td><td align="left">Environment variables to set during the build. <code>$(execpath)</code> macros may be used to point at files which are listed as <code>data</code>, <code>deps</code>, or <code>build_data</code>, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. This attribute is subject to make variable substitution. No other macros are supported.Variables containing <code>PATH</code> (e.g. <code>PATH</code>, <code>LD_LIBRARY_PATH</code>, <code>CPATH</code>) entries will be prepended to the existing variable.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||
|
|
<tr><td align="left"><a id="boost_build-includes"></a>includes</td><td align="left">Optional list of include dirs to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="boost_build-lib_name"></a>lib_name</td><td align="left">Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="boost_build-lib_source"></a>lib_source</td><td align="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||
|
|
<tr><td align="left"><a id="boost_build-linkopts"></a>linkopts</td><td align="left">Optional link options to be passed up to the dependencies of this library</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="boost_build-out_bin_dir"></a>out_bin_dir</td><td align="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"bin"</td></tr>
|
||
|
|
<tr><td align="left"><a id="boost_build-out_binaries"></a>out_binaries</td><td align="left">Optional names of the resulting binaries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="boost_build-out_data_dirs"></a>out_data_dirs</td><td align="left">Optional names of additional directories created by the build that should be declared as bazel action outputs</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="boost_build-out_headers_only"></a>out_headers_only</td><td align="left">Flag variable to indicate that the library produces only headers</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||
|
|
<tr><td align="left"><a id="boost_build-out_include_dir"></a>out_include_dir</td><td align="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"include"</td></tr>
|
||
|
|
<tr><td align="left"><a id="boost_build-out_interface_libs"></a>out_interface_libs</td><td align="left">Optional names of the resulting interface libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="boost_build-out_lib_dir"></a>out_lib_dir</td><td align="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"lib"</td></tr>
|
||
|
|
<tr><td align="left"><a id="boost_build-out_shared_libs"></a>out_shared_libs</td><td align="left">Optional names of the resulting shared libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="boost_build-out_static_libs"></a>out_static_libs</td><td align="left">Optional names of the resulting static libraries. Note that if <code>out_headers_only</code>, <code>out_static_libs</code>, <code>out_shared_libs</code>, and <code>out_binaries</code> are not set, default <code>lib_name.a</code>/<code>lib_name.lib</code> static library is assumed</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="boost_build-postfix_script"></a>postfix_script</td><td align="left">Optional part of the shell script to be added after the make commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="boost_build-tool_prefix"></a>tool_prefix</td><td align="left">A prefix for build commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="boost_build-tools_deps"></a>tools_deps</td><td align="left"><strong>deprecated</strong>: Please use the <code>build_data</code> attribute.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="boost_build-user_options"></a>user_options</td><td align="left">any additional flags to pass to b2</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
</tbody></table>
|
||
|
|
<p><a id="#cmake"></a></p>
|
||
|
|
<h2 id="cmake-1"><a class="header" href="#cmake-1">cmake</a></h2>
|
||
|
|
<pre>
|
||
|
|
cmake(<a href="flatten.html#cmake-name">name</a>, <a href="flatten.html#cmake-additional_inputs">additional_inputs</a>, <a href="flatten.html#cmake-additional_tools">additional_tools</a>, <a href="flatten.html#cmake-alwayslink">alwayslink</a>, <a href="flatten.html#cmake-build_args">build_args</a>, <a href="flatten.html#cmake-build_data">build_data</a>, <a href="flatten.html#cmake-cache_entries">cache_entries</a>,
|
||
|
|
<a href="flatten.html#cmake-copts">copts</a>, <a href="flatten.html#cmake-data">data</a>, <a href="flatten.html#cmake-defines">defines</a>, <a href="flatten.html#cmake-deps">deps</a>, <a href="flatten.html#cmake-env">env</a>, <a href="flatten.html#cmake-generate_args">generate_args</a>, <a href="flatten.html#cmake-generate_crosstool_file">generate_crosstool_file</a>, <a href="flatten.html#cmake-includes">includes</a>, <a href="flatten.html#cmake-install">install</a>,
|
||
|
|
<a href="flatten.html#cmake-install_args">install_args</a>, <a href="flatten.html#cmake-lib_name">lib_name</a>, <a href="flatten.html#cmake-lib_source">lib_source</a>, <a href="flatten.html#cmake-linkopts">linkopts</a>, <a href="flatten.html#cmake-out_bin_dir">out_bin_dir</a>, <a href="flatten.html#cmake-out_binaries">out_binaries</a>, <a href="flatten.html#cmake-out_data_dirs">out_data_dirs</a>,
|
||
|
|
<a href="flatten.html#cmake-out_headers_only">out_headers_only</a>, <a href="flatten.html#cmake-out_include_dir">out_include_dir</a>, <a href="flatten.html#cmake-out_interface_libs">out_interface_libs</a>, <a href="flatten.html#cmake-out_lib_dir">out_lib_dir</a>, <a href="flatten.html#cmake-out_shared_libs">out_shared_libs</a>,
|
||
|
|
<a href="flatten.html#cmake-out_static_libs">out_static_libs</a>, <a href="flatten.html#cmake-postfix_script">postfix_script</a>, <a href="flatten.html#cmake-targets">targets</a>, <a href="flatten.html#cmake-tool_prefix">tool_prefix</a>, <a href="flatten.html#cmake-tools_deps">tools_deps</a>, <a href="flatten.html#cmake-working_directory">working_directory</a>)
|
||
|
|
</pre>
|
||
|
|
<p>Rule for building external library with CMake.</p>
|
||
|
|
<p><strong>ATTRIBUTES</strong></p>
|
||
|
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||
|
|
<tr><td align="left"><a id="cmake-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-additional_inputs"></a>additional_inputs</td><td align="left"><strong>deprecated</strong>: Please use the <code>build_data</code> attribute.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-additional_tools"></a>additional_tools</td><td align="left"><strong>deprecated</strong>: Please use the <code>build_data</code> attribute.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-alwayslink"></a>alwayslink</td><td align="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-build_args"></a>build_args</td><td align="left">Arguments for the CMake build command</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-build_data"></a>build_data</td><td align="left">Files needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-cache_entries"></a>cache_entries</td><td align="left">CMake cache entries to initialize (they will be passed with <code>-Dkey=value</code>) Values, defined by the toolchain, will be joined with the values, passed here. (Toolchain values come first)</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-copts"></a>copts</td><td align="left">Optional. Add these options to the compile flags passed to the foreign build system. The flags only take affect for compiling this target, not its dependencies.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-data"></a>data</td><td align="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-defines"></a>defines</td><td align="left">Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-deps"></a>deps</td><td align="left">Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external build system will be looking for and paths to which are provided by the calling rule)</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-env"></a>env</td><td align="left">Environment variables to set during the build. <code>$(execpath)</code> macros may be used to point at files which are listed as <code>data</code>, <code>deps</code>, or <code>build_data</code>, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. This attribute is subject to make variable substitution. No other macros are supported.Variables containing <code>PATH</code> (e.g. <code>PATH</code>, <code>LD_LIBRARY_PATH</code>, <code>CPATH</code>) entries will be prepended to the existing variable.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-generate_args"></a>generate_args</td><td align="left">Arguments for CMake's generate command. Arguments should be passed as key/value pairs. eg: <code>["-G Ninja", "--debug-output", "-DFOO=bar"]</code>. Note that unless a generator (<code>-G</code>) argument is provided, the default generators are <a href="https://cmake.org/cmake/help/latest/generator/Unix%20Makefiles.html">Unix Makefiles</a> for Linux and MacOS and <a href="https://cmake.org/cmake/help/latest/generator/Ninja.html">Ninja</a> for Windows.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-generate_crosstool_file"></a>generate_crosstool_file</td><td align="left">When True, CMake crosstool file will be generated from the toolchain values, provided cache-entries and env_vars (some values will still be passed as <code>-Dkey=value</code> and environment variables). If <code>CMAKE_TOOLCHAIN_FILE</code> cache entry is passed, specified crosstool file will be used When using this option to cross-compile, it is required to specify <code>CMAKE_SYSTEM_NAME</code> in the cache_entries</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">True</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-includes"></a>includes</td><td align="left">Optional list of include dirs to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-install"></a>install</td><td align="left">If True, the <code>cmake --install</code> comand will be performed after a build</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">True</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-install_args"></a>install_args</td><td align="left">Arguments for the CMake install command</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-lib_name"></a>lib_name</td><td align="left">Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-lib_source"></a>lib_source</td><td align="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-linkopts"></a>linkopts</td><td align="left">Optional link options to be passed up to the dependencies of this library</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-out_bin_dir"></a>out_bin_dir</td><td align="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"bin"</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-out_binaries"></a>out_binaries</td><td align="left">Optional names of the resulting binaries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-out_data_dirs"></a>out_data_dirs</td><td align="left">Optional names of additional directories created by the build that should be declared as bazel action outputs</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-out_headers_only"></a>out_headers_only</td><td align="left">Flag variable to indicate that the library produces only headers</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-out_include_dir"></a>out_include_dir</td><td align="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"include"</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-out_interface_libs"></a>out_interface_libs</td><td align="left">Optional names of the resulting interface libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-out_lib_dir"></a>out_lib_dir</td><td align="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"lib"</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-out_shared_libs"></a>out_shared_libs</td><td align="left">Optional names of the resulting shared libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-out_static_libs"></a>out_static_libs</td><td align="left">Optional names of the resulting static libraries. Note that if <code>out_headers_only</code>, <code>out_static_libs</code>, <code>out_shared_libs</code>, and <code>out_binaries</code> are not set, default <code>lib_name.a</code>/<code>lib_name.lib</code> static library is assumed</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-postfix_script"></a>postfix_script</td><td align="left">Optional part of the shell script to be added after the make commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-targets"></a>targets</td><td align="left">A list of targets with in the foreign build system to produce. An empty string (<code>""</code>) will result in a call to the underlying build system with no explicit target set</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-tool_prefix"></a>tool_prefix</td><td align="left">A prefix for build commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-tools_deps"></a>tools_deps</td><td align="left"><strong>deprecated</strong>: Please use the <code>build_data</code> attribute.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake-working_directory"></a>working_directory</td><td align="left">Working directory, with the main CMakeLists.txt (otherwise, the top directory of the lib_source label files is used.)</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
</tbody></table>
|
||
|
|
<p><a id="#configure_make"></a></p>
|
||
|
|
<h2 id="configure_make-1"><a class="header" href="#configure_make-1">configure_make</a></h2>
|
||
|
|
<pre>
|
||
|
|
configure_make(<a href="flatten.html#configure_make-name">name</a>, <a href="flatten.html#configure_make-additional_inputs">additional_inputs</a>, <a href="flatten.html#configure_make-additional_tools">additional_tools</a>, <a href="flatten.html#configure_make-alwayslink">alwayslink</a>, <a href="flatten.html#configure_make-args">args</a>, <a href="flatten.html#configure_make-autoconf">autoconf</a>,
|
||
|
|
<a href="flatten.html#configure_make-autoconf_options">autoconf_options</a>, <a href="flatten.html#configure_make-autogen">autogen</a>, <a href="flatten.html#configure_make-autogen_command">autogen_command</a>, <a href="flatten.html#configure_make-autogen_options">autogen_options</a>, <a href="flatten.html#configure_make-autoreconf">autoreconf</a>,
|
||
|
|
<a href="flatten.html#configure_make-autoreconf_options">autoreconf_options</a>, <a href="flatten.html#configure_make-build_data">build_data</a>, <a href="flatten.html#configure_make-configure_command">configure_command</a>, <a href="flatten.html#configure_make-configure_in_place">configure_in_place</a>,
|
||
|
|
<a href="flatten.html#configure_make-configure_options">configure_options</a>, <a href="flatten.html#configure_make-configure_prefix">configure_prefix</a>, <a href="flatten.html#configure_make-copts">copts</a>, <a href="flatten.html#configure_make-data">data</a>, <a href="flatten.html#configure_make-defines">defines</a>, <a href="flatten.html#configure_make-deps">deps</a>, <a href="flatten.html#configure_make-env">env</a>, <a href="flatten.html#configure_make-includes">includes</a>,
|
||
|
|
<a href="flatten.html#configure_make-install_prefix">install_prefix</a>, <a href="flatten.html#configure_make-lib_name">lib_name</a>, <a href="flatten.html#configure_make-lib_source">lib_source</a>, <a href="flatten.html#configure_make-linkopts">linkopts</a>, <a href="flatten.html#configure_make-out_bin_dir">out_bin_dir</a>, <a href="flatten.html#configure_make-out_binaries">out_binaries</a>,
|
||
|
|
<a href="flatten.html#configure_make-out_data_dirs">out_data_dirs</a>, <a href="flatten.html#configure_make-out_headers_only">out_headers_only</a>, <a href="flatten.html#configure_make-out_include_dir">out_include_dir</a>, <a href="flatten.html#configure_make-out_interface_libs">out_interface_libs</a>, <a href="flatten.html#configure_make-out_lib_dir">out_lib_dir</a>,
|
||
|
|
<a href="flatten.html#configure_make-out_shared_libs">out_shared_libs</a>, <a href="flatten.html#configure_make-out_static_libs">out_static_libs</a>, <a href="flatten.html#configure_make-postfix_script">postfix_script</a>, <a href="flatten.html#configure_make-targets">targets</a>, <a href="flatten.html#configure_make-tool_prefix">tool_prefix</a>, <a href="flatten.html#configure_make-tools_deps">tools_deps</a>)
|
||
|
|
</pre>
|
||
|
|
<p>Rule for building external libraries with configure-make pattern. Some 'configure' script is invoked with --prefix=install (by default), and other parameters for compilation and linking, taken from Bazel C/C++ toolchain and passed dependencies. After configuration, GNU Make is called.</p>
|
||
|
|
<p><strong>ATTRIBUTES</strong></p>
|
||
|
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||
|
|
<tr><td align="left"><a id="configure_make-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-additional_inputs"></a>additional_inputs</td><td align="left"><strong>deprecated</strong>: Please use the <code>build_data</code> attribute.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-additional_tools"></a>additional_tools</td><td align="left"><strong>deprecated</strong>: Please use the <code>build_data</code> attribute.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-alwayslink"></a>alwayslink</td><td align="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-args"></a>args</td><td align="left">A list of arguments to pass to the call to <code>make</code></td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-autoconf"></a>autoconf</td><td align="left">Set to True if 'autoconf' should be invoked before 'configure', currently requires <code>configure_in_place</code> to be True.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-autoconf_options"></a>autoconf_options</td><td align="left">Any options to be put in the 'autoconf.sh' command line.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-autogen"></a>autogen</td><td align="left">Set to True if 'autogen.sh' should be invoked before 'configure', currently requires <code>configure_in_place</code> to be True.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-autogen_command"></a>autogen_command</td><td align="left">The name of the autogen script file, default: autogen.sh. Many projects use autogen.sh however the Autotools FAQ recommends bootstrap so we provide this option to support that.</td><td align="left">String</td><td align="left">optional</td><td align="left">"autogen.sh"</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-autogen_options"></a>autogen_options</td><td align="left">Any options to be put in the 'autogen.sh' command line.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-autoreconf"></a>autoreconf</td><td align="left">Set to True if 'autoreconf' should be invoked before 'configure.', currently requires <code>configure_in_place</code> to be True.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-autoreconf_options"></a>autoreconf_options</td><td align="left">Any options to be put in the 'autoreconf.sh' command line.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-build_data"></a>build_data</td><td align="left">Files needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-configure_command"></a>configure_command</td><td align="left">The name of the configuration script file, default: configure. The file must be in the root of the source directory.</td><td align="left">String</td><td align="left">optional</td><td align="left">"configure"</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-configure_in_place"></a>configure_in_place</td><td align="left">Set to True if 'configure' should be invoked in place, i.e. from its enclosing directory.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-configure_options"></a>configure_options</td><td align="left">Any options to be put on the 'configure' command line.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-configure_prefix"></a>configure_prefix</td><td align="left">A prefix for the call to the <code>configure_command</code>.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-copts"></a>copts</td><td align="left">Optional. Add these options to the compile flags passed to the foreign build system. The flags only take affect for compiling this target, not its dependencies.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-data"></a>data</td><td align="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-defines"></a>defines</td><td align="left">Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-deps"></a>deps</td><td align="left">Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external build system will be looking for and paths to which are provided by the calling rule)</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-env"></a>env</td><td align="left">Environment variables to set during the build. <code>$(execpath)</code> macros may be used to point at files which are listed as <code>data</code>, <code>deps</code>, or <code>build_data</code>, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. This attribute is subject to make variable substitution. No other macros are supported.Variables containing <code>PATH</code> (e.g. <code>PATH</code>, <code>LD_LIBRARY_PATH</code>, <code>CPATH</code>) entries will be prepended to the existing variable.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-includes"></a>includes</td><td align="left">Optional list of include dirs to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-install_prefix"></a>install_prefix</td><td align="left">Install prefix, i.e. relative path to where to install the result of the build. Passed to the 'configure' script with --prefix flag.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-lib_name"></a>lib_name</td><td align="left">Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-lib_source"></a>lib_source</td><td align="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-linkopts"></a>linkopts</td><td align="left">Optional link options to be passed up to the dependencies of this library</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-out_bin_dir"></a>out_bin_dir</td><td align="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"bin"</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-out_binaries"></a>out_binaries</td><td align="left">Optional names of the resulting binaries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-out_data_dirs"></a>out_data_dirs</td><td align="left">Optional names of additional directories created by the build that should be declared as bazel action outputs</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-out_headers_only"></a>out_headers_only</td><td align="left">Flag variable to indicate that the library produces only headers</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-out_include_dir"></a>out_include_dir</td><td align="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"include"</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-out_interface_libs"></a>out_interface_libs</td><td align="left">Optional names of the resulting interface libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-out_lib_dir"></a>out_lib_dir</td><td align="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"lib"</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-out_shared_libs"></a>out_shared_libs</td><td align="left">Optional names of the resulting shared libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-out_static_libs"></a>out_static_libs</td><td align="left">Optional names of the resulting static libraries. Note that if <code>out_headers_only</code>, <code>out_static_libs</code>, <code>out_shared_libs</code>, and <code>out_binaries</code> are not set, default <code>lib_name.a</code>/<code>lib_name.lib</code> static library is assumed</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-postfix_script"></a>postfix_script</td><td align="left">Optional part of the shell script to be added after the make commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-targets"></a>targets</td><td align="left">A list of targets within the foreign build system to produce. An empty string (<code>""</code>) will result in a call to the underlying build system with no explicit target set</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">["", "install"]</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-tool_prefix"></a>tool_prefix</td><td align="left">A prefix for build commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make-tools_deps"></a>tools_deps</td><td align="left"><strong>deprecated</strong>: Please use the <code>build_data</code> attribute.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
</tbody></table>
|
||
|
|
<p><a id="#make"></a></p>
|
||
|
|
<h2 id="make-1"><a class="header" href="#make-1">make</a></h2>
|
||
|
|
<pre>
|
||
|
|
make(<a href="flatten.html#make-name">name</a>, <a href="flatten.html#make-additional_inputs">additional_inputs</a>, <a href="flatten.html#make-additional_tools">additional_tools</a>, <a href="flatten.html#make-alwayslink">alwayslink</a>, <a href="flatten.html#make-args">args</a>, <a href="flatten.html#make-build_data">build_data</a>, <a href="flatten.html#make-copts">copts</a>, <a href="flatten.html#make-data">data</a>, <a href="flatten.html#make-defines">defines</a>,
|
||
|
|
<a href="flatten.html#make-deps">deps</a>, <a href="flatten.html#make-env">env</a>, <a href="flatten.html#make-includes">includes</a>, <a href="flatten.html#make-install_prefix">install_prefix</a>, <a href="flatten.html#make-lib_name">lib_name</a>, <a href="flatten.html#make-lib_source">lib_source</a>, <a href="flatten.html#make-linkopts">linkopts</a>, <a href="flatten.html#make-out_bin_dir">out_bin_dir</a>, <a href="flatten.html#make-out_binaries">out_binaries</a>,
|
||
|
|
<a href="flatten.html#make-out_data_dirs">out_data_dirs</a>, <a href="flatten.html#make-out_headers_only">out_headers_only</a>, <a href="flatten.html#make-out_include_dir">out_include_dir</a>, <a href="flatten.html#make-out_interface_libs">out_interface_libs</a>, <a href="flatten.html#make-out_lib_dir">out_lib_dir</a>,
|
||
|
|
<a href="flatten.html#make-out_shared_libs">out_shared_libs</a>, <a href="flatten.html#make-out_static_libs">out_static_libs</a>, <a href="flatten.html#make-postfix_script">postfix_script</a>, <a href="flatten.html#make-targets">targets</a>, <a href="flatten.html#make-tool_prefix">tool_prefix</a>, <a href="flatten.html#make-tools_deps">tools_deps</a>)
|
||
|
|
</pre>
|
||
|
|
<p>Rule for building external libraries with GNU Make. GNU Make commands (make and make install by default) are invoked with PREFIX="install" (by default), and other environment variables for compilation and linking, taken from Bazel C/C++ toolchain and passed dependencies.</p>
|
||
|
|
<p><strong>ATTRIBUTES</strong></p>
|
||
|
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||
|
|
<tr><td align="left"><a id="make-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||
|
|
<tr><td align="left"><a id="make-additional_inputs"></a>additional_inputs</td><td align="left"><strong>deprecated</strong>: Please use the <code>build_data</code> attribute.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-additional_tools"></a>additional_tools</td><td align="left"><strong>deprecated</strong>: Please use the <code>build_data</code> attribute.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-alwayslink"></a>alwayslink</td><td align="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-args"></a>args</td><td align="left">A list of arguments to pass to the call to <code>make</code></td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-build_data"></a>build_data</td><td align="left">Files needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-copts"></a>copts</td><td align="left">Optional. Add these options to the compile flags passed to the foreign build system. The flags only take affect for compiling this target, not its dependencies.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-data"></a>data</td><td align="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-defines"></a>defines</td><td align="left">Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-deps"></a>deps</td><td align="left">Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external build system will be looking for and paths to which are provided by the calling rule)</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-env"></a>env</td><td align="left">Environment variables to set during the build. <code>$(execpath)</code> macros may be used to point at files which are listed as <code>data</code>, <code>deps</code>, or <code>build_data</code>, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. This attribute is subject to make variable substitution. No other macros are supported.Variables containing <code>PATH</code> (e.g. <code>PATH</code>, <code>LD_LIBRARY_PATH</code>, <code>CPATH</code>) entries will be prepended to the existing variable.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-includes"></a>includes</td><td align="left">Optional list of include dirs to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-install_prefix"></a>install_prefix</td><td align="left">Install prefix, i.e. relative path to where to install the result of the build. Passed as an arg to "make" as PREFIX=<install_prefix>.</td><td align="left">String</td><td align="left">optional</td><td align="left">"$$INSTALLDIR$$"</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-lib_name"></a>lib_name</td><td align="left">Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-lib_source"></a>lib_source</td><td align="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||
|
|
<tr><td align="left"><a id="make-linkopts"></a>linkopts</td><td align="left">Optional link options to be passed up to the dependencies of this library</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-out_bin_dir"></a>out_bin_dir</td><td align="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"bin"</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-out_binaries"></a>out_binaries</td><td align="left">Optional names of the resulting binaries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-out_data_dirs"></a>out_data_dirs</td><td align="left">Optional names of additional directories created by the build that should be declared as bazel action outputs</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-out_headers_only"></a>out_headers_only</td><td align="left">Flag variable to indicate that the library produces only headers</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-out_include_dir"></a>out_include_dir</td><td align="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"include"</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-out_interface_libs"></a>out_interface_libs</td><td align="left">Optional names of the resulting interface libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-out_lib_dir"></a>out_lib_dir</td><td align="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"lib"</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-out_shared_libs"></a>out_shared_libs</td><td align="left">Optional names of the resulting shared libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-out_static_libs"></a>out_static_libs</td><td align="left">Optional names of the resulting static libraries. Note that if <code>out_headers_only</code>, <code>out_static_libs</code>, <code>out_shared_libs</code>, and <code>out_binaries</code> are not set, default <code>lib_name.a</code>/<code>lib_name.lib</code> static library is assumed</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-postfix_script"></a>postfix_script</td><td align="left">Optional part of the shell script to be added after the make commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-targets"></a>targets</td><td align="left">A list of targets within the foreign build system to produce. An empty string (<code>""</code>) will result in a call to the underlying build system with no explicit target set</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">["", "install"]</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-tool_prefix"></a>tool_prefix</td><td align="left">A prefix for build commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="make-tools_deps"></a>tools_deps</td><td align="left"><strong>deprecated</strong>: Please use the <code>build_data</code> attribute.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
</tbody></table>
|
||
|
|
<p><a id="#make_tool"></a></p>
|
||
|
|
<h2 id="make_tool"><a class="header" href="#make_tool">make_tool</a></h2>
|
||
|
|
<pre>
|
||
|
|
make_tool(<a href="flatten.html#make_tool-name">name</a>, <a href="flatten.html#make_tool-env">env</a>, <a href="flatten.html#make_tool-srcs">srcs</a>)
|
||
|
|
</pre>
|
||
|
|
<p>Rule for building Make. Invokes configure script and make install.</p>
|
||
|
|
<p><strong>ATTRIBUTES</strong></p>
|
||
|
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||
|
|
<tr><td align="left"><a id="make_tool-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||
|
|
<tr><td align="left"><a id="make_tool-env"></a>env</td><td align="left">Environment variables to set during the build. This attribute is subject to make variable substitution.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||
|
|
<tr><td align="left"><a id="make_tool-srcs"></a>srcs</td><td align="left">The target containing the build tool's sources</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||
|
|
</tbody></table>
|
||
|
|
<p><a id="#native_tool_toolchain"></a></p>
|
||
|
|
<h2 id="native_tool_toolchain"><a class="header" href="#native_tool_toolchain">native_tool_toolchain</a></h2>
|
||
|
|
<pre>
|
||
|
|
native_tool_toolchain(<a href="flatten.html#native_tool_toolchain-name">name</a>, <a href="flatten.html#native_tool_toolchain-path">path</a>, <a href="flatten.html#native_tool_toolchain-target">target</a>)
|
||
|
|
</pre>
|
||
|
|
<p>Rule for defining the toolchain data of the native tools (cmake, ninja), to be used by rules_foreign_cc with toolchain types <code>@rules_foreign_cc//toolchains:cmake_toolchain</code> and <code>@rules_foreign_cc//toolchains:ninja_toolchain</code>.</p>
|
||
|
|
<p><strong>ATTRIBUTES</strong></p>
|
||
|
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||
|
|
<tr><td align="left"><a id="native_tool_toolchain-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||
|
|
<tr><td align="left"><a id="native_tool_toolchain-path"></a>path</td><td align="left">Absolute path to the tool in case the tool is preinstalled on the machine. Relative path to the tool in case the tool is built as part of a build; the path should be relative to the bazel-genfiles, i.e. it should start with the name of the top directory of the built tree artifact. (Please see the example <code>//examples:built_cmake_toolchain</code>)</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="native_tool_toolchain-target"></a>target</td><td align="left">If the tool is preinstalled, must be None. If the tool is built as part of the build, the corresponding build target, which should produce the tree artifact with the binary to call.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">optional</td><td align="left">None</td></tr>
|
||
|
|
</tbody></table>
|
||
|
|
<p><a id="#ninja"></a></p>
|
||
|
|
<h2 id="ninja-1"><a class="header" href="#ninja-1">ninja</a></h2>
|
||
|
|
<pre>
|
||
|
|
ninja(<a href="flatten.html#ninja-name">name</a>, <a href="flatten.html#ninja-additional_inputs">additional_inputs</a>, <a href="flatten.html#ninja-additional_tools">additional_tools</a>, <a href="flatten.html#ninja-alwayslink">alwayslink</a>, <a href="flatten.html#ninja-args">args</a>, <a href="flatten.html#ninja-build_data">build_data</a>, <a href="flatten.html#ninja-copts">copts</a>, <a href="flatten.html#ninja-data">data</a>, <a href="flatten.html#ninja-defines">defines</a>,
|
||
|
|
<a href="flatten.html#ninja-deps">deps</a>, <a href="flatten.html#ninja-directory">directory</a>, <a href="flatten.html#ninja-env">env</a>, <a href="flatten.html#ninja-includes">includes</a>, <a href="flatten.html#ninja-lib_name">lib_name</a>, <a href="flatten.html#ninja-lib_source">lib_source</a>, <a href="flatten.html#ninja-linkopts">linkopts</a>, <a href="flatten.html#ninja-out_bin_dir">out_bin_dir</a>, <a href="flatten.html#ninja-out_binaries">out_binaries</a>,
|
||
|
|
<a href="flatten.html#ninja-out_data_dirs">out_data_dirs</a>, <a href="flatten.html#ninja-out_headers_only">out_headers_only</a>, <a href="flatten.html#ninja-out_include_dir">out_include_dir</a>, <a href="flatten.html#ninja-out_interface_libs">out_interface_libs</a>, <a href="flatten.html#ninja-out_lib_dir">out_lib_dir</a>,
|
||
|
|
<a href="flatten.html#ninja-out_shared_libs">out_shared_libs</a>, <a href="flatten.html#ninja-out_static_libs">out_static_libs</a>, <a href="flatten.html#ninja-postfix_script">postfix_script</a>, <a href="flatten.html#ninja-targets">targets</a>, <a href="flatten.html#ninja-tool_prefix">tool_prefix</a>, <a href="flatten.html#ninja-tools_deps">tools_deps</a>)
|
||
|
|
</pre>
|
||
|
|
<p>Rule for building external libraries with <a href="https://ninja-build.org/">Ninja</a>.</p>
|
||
|
|
<p><strong>ATTRIBUTES</strong></p>
|
||
|
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||
|
|
<tr><td align="left"><a id="ninja-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-additional_inputs"></a>additional_inputs</td><td align="left"><strong>deprecated</strong>: Please use the <code>build_data</code> attribute.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-additional_tools"></a>additional_tools</td><td align="left"><strong>deprecated</strong>: Please use the <code>build_data</code> attribute.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-alwayslink"></a>alwayslink</td><td align="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-args"></a>args</td><td align="left">A list of arguments to pass to the call to <code>ninja</code></td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-build_data"></a>build_data</td><td align="left">Files needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-copts"></a>copts</td><td align="left">Optional. Add these options to the compile flags passed to the foreign build system. The flags only take affect for compiling this target, not its dependencies.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-data"></a>data</td><td align="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-defines"></a>defines</td><td align="left">Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-deps"></a>deps</td><td align="left">Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external build system will be looking for and paths to which are provided by the calling rule)</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-directory"></a>directory</td><td align="left">A directory to pass as the <code>-C</code> argument. The rule will always use the root directory of the <code>lib_sources</code> attribute if this attribute is not set</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-env"></a>env</td><td align="left">Environment variables to set during the build. <code>$(execpath)</code> macros may be used to point at files which are listed as <code>data</code>, <code>deps</code>, or <code>build_data</code>, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. This attribute is subject to make variable substitution. No other macros are supported.Variables containing <code>PATH</code> (e.g. <code>PATH</code>, <code>LD_LIBRARY_PATH</code>, <code>CPATH</code>) entries will be prepended to the existing variable.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-includes"></a>includes</td><td align="left">Optional list of include dirs to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-lib_name"></a>lib_name</td><td align="left">Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-lib_source"></a>lib_source</td><td align="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-linkopts"></a>linkopts</td><td align="left">Optional link options to be passed up to the dependencies of this library</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-out_bin_dir"></a>out_bin_dir</td><td align="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"bin"</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-out_binaries"></a>out_binaries</td><td align="left">Optional names of the resulting binaries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-out_data_dirs"></a>out_data_dirs</td><td align="left">Optional names of additional directories created by the build that should be declared as bazel action outputs</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-out_headers_only"></a>out_headers_only</td><td align="left">Flag variable to indicate that the library produces only headers</td><td align="left">Boolean</td><td align="left">optional</td><td align="left">False</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-out_include_dir"></a>out_include_dir</td><td align="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"include"</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-out_interface_libs"></a>out_interface_libs</td><td align="left">Optional names of the resulting interface libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-out_lib_dir"></a>out_lib_dir</td><td align="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><td align="left">String</td><td align="left">optional</td><td align="left">"lib"</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-out_shared_libs"></a>out_shared_libs</td><td align="left">Optional names of the resulting shared libraries.</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-out_static_libs"></a>out_static_libs</td><td align="left">Optional names of the resulting static libraries. Note that if <code>out_headers_only</code>, <code>out_static_libs</code>, <code>out_shared_libs</code>, and <code>out_binaries</code> are not set, default <code>lib_name.a</code>/<code>lib_name.lib</code> static library is assumed</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-postfix_script"></a>postfix_script</td><td align="left">Optional part of the shell script to be added after the make commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-targets"></a>targets</td><td align="left">A list of targets with in the foreign build system to produce. An empty string (<code>""</code>) will result in a call to the underlying build system with no explicit target set</td><td align="left">List of strings</td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-tool_prefix"></a>tool_prefix</td><td align="left">A prefix for build commands</td><td align="left">String</td><td align="left">optional</td><td align="left">""</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja-tools_deps"></a>tools_deps</td><td align="left"><strong>deprecated</strong>: Please use the <code>build_data</code> attribute.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><td align="left">optional</td><td align="left">[]</td></tr>
|
||
|
|
</tbody></table>
|
||
|
|
<p><a id="#ninja_tool"></a></p>
|
||
|
|
<h2 id="ninja_tool"><a class="header" href="#ninja_tool">ninja_tool</a></h2>
|
||
|
|
<pre>
|
||
|
|
ninja_tool(<a href="flatten.html#ninja_tool-name">name</a>, <a href="flatten.html#ninja_tool-env">env</a>, <a href="flatten.html#ninja_tool-srcs">srcs</a>)
|
||
|
|
</pre>
|
||
|
|
<p>Rule for building Ninja. Invokes configure script.</p>
|
||
|
|
<p><strong>ATTRIBUTES</strong></p>
|
||
|
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Type</th><th align="left">Mandatory</th><th align="left">Default</th></tr></thead><tbody>
|
||
|
|
<tr><td align="left"><a id="ninja_tool-name"></a>name</td><td align="left">A unique name for this target.</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#name">Name</a></td><td align="left">required</td><td align="left"></td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja_tool-env"></a>env</td><td align="left">Environment variables to set during the build. This attribute is subject to make variable substitution.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><td align="left">optional</td><td align="left">{}</td></tr>
|
||
|
|
<tr><td align="left"><a id="ninja_tool-srcs"></a>srcs</td><td align="left">The target containing the build tool's sources</td><td align="left"><a href="https://bazel.build/docs/build-ref.html#labels">Label</a></td><td align="left">required</td><td align="left"></td></tr>
|
||
|
|
</tbody></table>
|
||
|
|
<p><a id="#ForeignCcArtifactInfo"></a></p>
|
||
|
|
<h2 id="foreignccartifactinfo"><a class="header" href="#foreignccartifactinfo">ForeignCcArtifactInfo</a></h2>
|
||
|
|
<pre>
|
||
|
|
ForeignCcArtifactInfo(<a href="flatten.html#ForeignCcArtifactInfo-bin_dir_name">bin_dir_name</a>, <a href="flatten.html#ForeignCcArtifactInfo-gen_dir">gen_dir</a>, <a href="flatten.html#ForeignCcArtifactInfo-include_dir_name">include_dir_name</a>, <a href="flatten.html#ForeignCcArtifactInfo-lib_dir_name">lib_dir_name</a>)
|
||
|
|
</pre>
|
||
|
|
<p>Groups information about the external library install directory,
|
||
|
|
and relative bin, include and lib directories.</p>
|
||
|
|
<p>Serves to pass transitive information about externally built artifacts up the dependency chain.</p>
|
||
|
|
<p>Can not be used as a top-level provider.
|
||
|
|
Instances of ForeignCcArtifactInfo are encapsulated in a depset <a href="flatten.html#ForeignCcDepsInfo-artifacts">ForeignCcDepsInfo::artifacts</a>.</p>
|
||
|
|
<p><strong>FIELDS</strong></p>
|
||
|
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th></tr></thead><tbody>
|
||
|
|
<tr><td align="left"><a id="ForeignCcArtifactInfo-bin_dir_name"></a>bin_dir_name</td><td align="left">Bin directory, relative to install directory</td></tr>
|
||
|
|
<tr><td align="left"><a id="ForeignCcArtifactInfo-gen_dir"></a>gen_dir</td><td align="left">Install directory</td></tr>
|
||
|
|
<tr><td align="left"><a id="ForeignCcArtifactInfo-include_dir_name"></a>include_dir_name</td><td align="left">Include directory, relative to install directory</td></tr>
|
||
|
|
<tr><td align="left"><a id="ForeignCcArtifactInfo-lib_dir_name"></a>lib_dir_name</td><td align="left">Lib directory, relative to install directory</td></tr>
|
||
|
|
</tbody></table>
|
||
|
|
<p><a id="#ForeignCcDepsInfo"></a></p>
|
||
|
|
<h2 id="foreignccdepsinfo"><a class="header" href="#foreignccdepsinfo">ForeignCcDepsInfo</a></h2>
|
||
|
|
<pre>
|
||
|
|
ForeignCcDepsInfo(<a href="flatten.html#ForeignCcDepsInfo-artifacts">artifacts</a>)
|
||
|
|
</pre>
|
||
|
|
<p>Provider to pass transitive information about external libraries.</p>
|
||
|
|
<p><strong>FIELDS</strong></p>
|
||
|
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th></tr></thead><tbody>
|
||
|
|
<tr><td align="left"><a id="ForeignCcDepsInfo-artifacts"></a>artifacts</td><td align="left">Depset of ForeignCcArtifactInfo</td></tr>
|
||
|
|
</tbody></table>
|
||
|
|
<p><a id="#ToolInfo"></a></p>
|
||
|
|
<h2 id="toolinfo"><a class="header" href="#toolinfo">ToolInfo</a></h2>
|
||
|
|
<pre>
|
||
|
|
ToolInfo(<a href="flatten.html#ToolInfo-path">path</a>, <a href="flatten.html#ToolInfo-target">target</a>)
|
||
|
|
</pre>
|
||
|
|
<p>Information about the native tool</p>
|
||
|
|
<p><strong>FIELDS</strong></p>
|
||
|
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th></tr></thead><tbody>
|
||
|
|
<tr><td align="left"><a id="ToolInfo-path"></a>path</td><td align="left">Absolute path to the tool in case the tool is preinstalled on the machine. Relative path to the tool in case the tool is built as part of a build; the path should be relative to the bazel-genfiles, i.e. it should start with the name of the top directory of the built tree artifact. (Please see the example <code>//examples:built_cmake_toolchain</code>)</td></tr>
|
||
|
|
<tr><td align="left"><a id="ToolInfo-target"></a>target</td><td align="left">If the tool is preinstalled, must be None. If the tool is built as part of the build, the corresponding build target, which should produce the tree artifact with the binary to call.</td></tr>
|
||
|
|
</tbody></table>
|
||
|
|
<p><a id="#cmake_tool"></a></p>
|
||
|
|
<h2 id="cmake_tool"><a class="header" href="#cmake_tool">cmake_tool</a></h2>
|
||
|
|
<pre>
|
||
|
|
cmake_tool(<a href="flatten.html#cmake_tool-name">name</a>, <a href="flatten.html#cmake_tool-srcs">srcs</a>, <a href="flatten.html#cmake_tool-kwargs">kwargs</a>)
|
||
|
|
</pre>
|
||
|
|
<p><strong>PARAMETERS</strong></p>
|
||
|
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Default Value</th></tr></thead><tbody>
|
||
|
|
<tr><td align="left"><a id="cmake_tool-name"></a>name</td><td align="left"><p align="center"> - </p></td><td align="left">none</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake_tool-srcs"></a>srcs</td><td align="left"><p align="center"> - </p></td><td align="left">none</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake_tool-kwargs"></a>kwargs</td><td align="left"><p align="center"> - </p></td><td align="left">none</td></tr>
|
||
|
|
</tbody></table>
|
||
|
|
<p><a id="#cmake_variant"></a></p>
|
||
|
|
<h2 id="cmake_variant-1"><a class="header" href="#cmake_variant-1">cmake_variant</a></h2>
|
||
|
|
<pre>
|
||
|
|
cmake_variant(<a href="flatten.html#cmake_variant-name">name</a>, <a href="flatten.html#cmake_variant-toolchain">toolchain</a>, <a href="flatten.html#cmake_variant-kwargs">kwargs</a>)
|
||
|
|
</pre>
|
||
|
|
<p>Wrapper macro around the cmake() rule to force usage of the given make variant toolchain.</p>
|
||
|
|
<p><strong>PARAMETERS</strong></p>
|
||
|
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Default Value</th></tr></thead><tbody>
|
||
|
|
<tr><td align="left"><a id="cmake_variant-name"></a>name</td><td align="left">The target name</td><td align="left">none</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake_variant-toolchain"></a>toolchain</td><td align="left">The desired make variant toolchain to use, e.g. @rules_foreign_cc//toolchains:preinstalled_nmake_toolchain</td><td align="left">none</td></tr>
|
||
|
|
<tr><td align="left"><a id="cmake_variant-kwargs"></a>kwargs</td><td align="left">Remaining keyword arguments</td><td align="left">none</td></tr>
|
||
|
|
</tbody></table>
|
||
|
|
<p><a id="#configure_make_variant"></a></p>
|
||
|
|
<h2 id="configure_make_variant-1"><a class="header" href="#configure_make_variant-1">configure_make_variant</a></h2>
|
||
|
|
<pre>
|
||
|
|
configure_make_variant(<a href="flatten.html#configure_make_variant-name">name</a>, <a href="flatten.html#configure_make_variant-toolchain">toolchain</a>, <a href="flatten.html#configure_make_variant-kwargs">kwargs</a>)
|
||
|
|
</pre>
|
||
|
|
<p>Wrapper macro around the configure_make() rule to force usage of the given make variant toolchain.</p>
|
||
|
|
<p><strong>PARAMETERS</strong></p>
|
||
|
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Default Value</th></tr></thead><tbody>
|
||
|
|
<tr><td align="left"><a id="configure_make_variant-name"></a>name</td><td align="left">The target name</td><td align="left">none</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make_variant-toolchain"></a>toolchain</td><td align="left">The desired make variant toolchain to use, e.g. @rules_foreign_cc//toolchains:preinstalled_nmake_toolchain</td><td align="left">none</td></tr>
|
||
|
|
<tr><td align="left"><a id="configure_make_variant-kwargs"></a>kwargs</td><td align="left">Remaining keyword arguments</td><td align="left">none</td></tr>
|
||
|
|
</tbody></table>
|
||
|
|
<p><a id="#make_variant"></a></p>
|
||
|
|
<h2 id="make_variant-1"><a class="header" href="#make_variant-1">make_variant</a></h2>
|
||
|
|
<pre>
|
||
|
|
make_variant(<a href="flatten.html#make_variant-name">name</a>, <a href="flatten.html#make_variant-toolchain">toolchain</a>, <a href="flatten.html#make_variant-kwargs">kwargs</a>)
|
||
|
|
</pre>
|
||
|
|
<p>Wrapper macro around the make() rule to force usage of the given make variant toolchain.</p>
|
||
|
|
<p><strong>PARAMETERS</strong></p>
|
||
|
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Default Value</th></tr></thead><tbody>
|
||
|
|
<tr><td align="left"><a id="make_variant-name"></a>name</td><td align="left">The target name</td><td align="left">none</td></tr>
|
||
|
|
<tr><td align="left"><a id="make_variant-toolchain"></a>toolchain</td><td align="left">The desired make variant toolchain to use, e.g. @rules_foreign_cc//toolchains:preinstalled_nmake_toolchain</td><td align="left">none</td></tr>
|
||
|
|
<tr><td align="left"><a id="make_variant-kwargs"></a>kwargs</td><td align="left">Remaining keyword arguments</td><td align="left">none</td></tr>
|
||
|
|
</tbody></table>
|
||
|
|
<p><a id="#rules_foreign_cc_dependencies"></a></p>
|
||
|
|
<h2 id="rules_foreign_cc_dependencies"><a class="header" href="#rules_foreign_cc_dependencies">rules_foreign_cc_dependencies</a></h2>
|
||
|
|
<pre>
|
||
|
|
rules_foreign_cc_dependencies(<a href="flatten.html#rules_foreign_cc_dependencies-native_tools_toolchains">native_tools_toolchains</a>, <a href="flatten.html#rules_foreign_cc_dependencies-register_default_tools">register_default_tools</a>, <a href="flatten.html#rules_foreign_cc_dependencies-cmake_version">cmake_version</a>,
|
||
|
|
<a href="flatten.html#rules_foreign_cc_dependencies-make_version">make_version</a>, <a href="flatten.html#rules_foreign_cc_dependencies-ninja_version">ninja_version</a>, <a href="flatten.html#rules_foreign_cc_dependencies-register_preinstalled_tools">register_preinstalled_tools</a>,
|
||
|
|
<a href="flatten.html#rules_foreign_cc_dependencies-register_built_tools">register_built_tools</a>, <a href="flatten.html#rules_foreign_cc_dependencies-register_toolchains">register_toolchains</a>)
|
||
|
|
</pre>
|
||
|
|
<p>Call this function from the WORKSPACE file to initialize rules_foreign_cc dependencies and let neccesary code generation happen (Code generation is needed to support different variants of the C++ Starlark API.).</p>
|
||
|
|
<p><strong>PARAMETERS</strong></p>
|
||
|
|
<table><thead><tr><th align="left">Name</th><th align="left">Description</th><th align="left">Default Value</th></tr></thead><tbody>
|
||
|
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-native_tools_toolchains"></a>native_tools_toolchains</td><td align="left">pass the toolchains for toolchain types '@rules_foreign_cc//toolchains:cmake_toolchain' and '@rules_foreign_cc//toolchains:ninja_toolchain' with the needed platform constraints. If you do not pass anything, registered default toolchains will be selected (see below).</td><td align="left"><code>[]</code></td></tr>
|
||
|
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-register_default_tools"></a>register_default_tools</td><td align="left">If True, the cmake and ninja toolchains, calling corresponding preinstalled binaries by name (cmake, ninja) will be registered after 'native_tools_toolchains' without any platform constraints. The default is True.</td><td align="left"><code>True</code></td></tr>
|
||
|
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-cmake_version"></a>cmake_version</td><td align="left">The target version of the cmake toolchain if <code>register_default_tools</code> or <code>register_built_tools</code> is set to <code>True</code>.</td><td align="left"><code>"3.22.1"</code></td></tr>
|
||
|
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-make_version"></a>make_version</td><td align="left">The target version of the default make toolchain if <code>register_built_tools</code> is set to <code>True</code>.</td><td align="left"><code>"4.3"</code></td></tr>
|
||
|
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-ninja_version"></a>ninja_version</td><td align="left">The target version of the ninja toolchain if <code>register_default_tools</code> or <code>register_built_tools</code> is set to <code>True</code>.</td><td align="left"><code>"1.10.2"</code></td></tr>
|
||
|
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-register_preinstalled_tools"></a>register_preinstalled_tools</td><td align="left">If true, toolchains will be registered for the native built tools installed on the exec host</td><td align="left"><code>True</code></td></tr>
|
||
|
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-register_built_tools"></a>register_built_tools</td><td align="left">If true, toolchains that build the tools from source are registered</td><td align="left"><code>True</code></td></tr>
|
||
|
|
<tr><td align="left"><a id="rules_foreign_cc_dependencies-register_toolchains"></a>register_toolchains</td><td align="left">If true, registers the toolchains via native.register_toolchains. Used by bzlmod</td><td align="left"><code>True</code></td></tr>
|
||
|
|
</tbody></table>
|
||
|
|
|
||
|
|
</main>
|
||
|
|
|
||
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
||
|
|
<!-- Mobile navigation buttons -->
|
||
|
|
|
||
|
|
|
||
|
|
<div style="clear: both"></div>
|
||
|
|
</nav>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
||
|
|
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
window.playground_copyable = true;
|
||
|
|
</script>
|
||
|
|
|
||
|
|
|
||
|
|
<script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="searcher.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
|
||
|
|
<script src="clipboard.min.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="highlight.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="book.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
|
||
|
|
<!-- Custom JS scripts -->
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
window.addEventListener('load', function() {
|
||
|
|
window.setTimeout(window.print, 100);
|
||
|
|
});
|
||
|
|
</script>
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|