bazel/rules_foreign_cc
2
0
Fork 0
mirror of https://github.com/bazel-contrib/rules_foreign_cc synced 2024-12-04 08:02:31 +00:00
Code Issues Releases Activity
rules_foreign_cc/main/configure_make.html

257 lines
26 KiB
HTML
Raw Normal View History

deploy: cb1d3cbcf8df55a0b5a3c39bdd1afad553139eb7
2021-06-22 19:11:04 +00:00
<!DOCTYPE HTML>
<html lang="en" class="sidebar-visible no-js light">
<head>
<!-- Book generated using mdBook -->
<meta charset="UTF-8">
<title>configure_make - Rules ForeignCc</title>
<!-- 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" class="active"><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>
<!-- 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-name">name</a>, <a href="#configure_make-additional_inputs">additional_inputs</a>, <a href="#configure_make-additional_tools">additional_tools</a>, <a href="#configure_make-alwayslink">alwayslink</a>, <a href="#configure_make-args">args</a>, <a href="#configure_make-autoconf">autoconf</a>,
<a href="#configure_make-autoconf_options">autoconf_options</a>, <a href="#configure_make-autogen">autogen</a>, <a href="#configure_make-autogen_command">autogen_command</a>, <a href="#configure_make-autogen_options">autogen_options</a>, <a href="#configure_make-autoreconf">autoreconf</a>,
<a href="#configure_make-autoreconf_options">autoreconf_options</a>, <a href="#configure_make-build_data">build_data</a>, <a href="#configure_make-configure_command">configure_command</a>, <a href="#configure_make-configure_in_place">configure_in_place</a>,
deploy: bb2f0ab0aa7bf1cbcd4836dbfca353f06fd38c41
2021-07-06 22:00:13 +00:00
<a href="#configure_make-configure_options">configure_options</a>, <a href="#configure_make-configure_prefix">configure_prefix</a>, <a href="#configure_make-copts">copts</a>, <a href="#configure_make-data">data</a>, <a href="#configure_make-defines">defines</a>, <a href="#configure_make-deps">deps</a>, <a href="#configure_make-env">env</a>, <a href="#configure_make-install_prefix">install_prefix</a>,
deploy: cb1d3cbcf8df55a0b5a3c39bdd1afad553139eb7
2021-06-22 19:11:04 +00:00
<a href="#configure_make-lib_name">lib_name</a>, <a href="#configure_make-lib_source">lib_source</a>, <a href="#configure_make-linkopts">linkopts</a>, <a href="#configure_make-out_bin_dir">out_bin_dir</a>, <a href="#configure_make-out_binaries">out_binaries</a>, <a href="#configure_make-out_data_dirs">out_data_dirs</a>,
<a href="#configure_make-out_headers_only">out_headers_only</a>, <a href="#configure_make-out_include_dir">out_include_dir</a>, <a href="#configure_make-out_interface_libs">out_interface_libs</a>, <a href="#configure_make-out_lib_dir">out_lib_dir</a>, <a href="#configure_make-out_shared_libs">out_shared_libs</a>,
<a href="#configure_make-out_static_libs">out_static_libs</a>, <a href="#configure_make-postfix_script">postfix_script</a>, <a href="#configure_make-targets">targets</a>, <a href="#configure_make-tool_prefix">tool_prefix</a>, <a href="#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">&quot;autogen.sh&quot;</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">&quot;configure&quot;</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">&quot;&quot;</td></tr>
deploy: bb2f0ab0aa7bf1cbcd4836dbfca353f06fd38c41
2021-07-06 22:00:13 +00:00
<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>
deploy: cb1d3cbcf8df55a0b5a3c39bdd1afad553139eb7
2021-06-22 19:11:04 +00:00
<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>
deploy: f9885a80664fcfb2ab49460b2aed2bbff985d073
2021-07-19 18:00:34 +00:00
<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>
deploy: cb1d3cbcf8df55a0b5a3c39bdd1afad553139eb7
2021-06-22 19:11:04 +00:00
<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. No other macros are supported.</td><td align="left"><a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -&gt; String</a></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">&quot;&quot;</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">&quot;&quot;</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">&quot;bin&quot;</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">&quot;include&quot;</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">&quot;lib&quot;</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">&quot;&quot;</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>&quot;&quot;</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">[&quot;&quot;, &quot;install&quot;]</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">&quot;&quot;</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>
</main>
<nav class="nav-wrapper" aria-label="Page navigation">
<!-- Mobile navigation buttons -->
<a rel="prev" href="cmake.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>
<a rel="next" href="make.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
<div style="clear: both"></div>
</nav>
</div>
</div>
<nav class="nav-wide-wrapper" aria-label="Page navigation">
<a rel="prev" href="cmake.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>
<a rel="next" href="make.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
</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 -->
</body>
</html>
Copy permalink