2022-04-18 12:58:41 +00:00
<!DOCTYPE HTML>
2024-11-26 22:42:53 +00:00
< html lang = "en" class = "light sidebar-visible" dir = "ltr" >
2022-04-18 12:58:41 +00:00
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
< title > Rules ForeignCc - Rules ForeignCc< / title >
2024-11-26 22:42:53 +00:00
2022-04-18 12:58:41 +00:00
<!-- Custom HTML head -->
< meta name = "description" content = "" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
2024-11-26 22:42:53 +00:00
< meta name = "theme-color" content = "#ffffff" >
2022-04-18 12:58:41 +00:00
2024-11-26 22:42:53 +00:00
< link rel = "icon" href = "favicon.svg" >
< link rel = "shortcut icon" href = "favicon.png" >
< link rel = "stylesheet" href = "css/variables.css" >
2022-04-18 12:58:41 +00:00
< link rel = "stylesheet" href = "css/general.css" >
< link rel = "stylesheet" href = "css/chrome.css" >
2024-11-26 22:42:53 +00:00
< link rel = "stylesheet" href = "css/print.css" media = "print" >
2022-04-18 12:58:41 +00:00
<!-- Fonts -->
< link rel = "stylesheet" href = "FontAwesome/css/font-awesome.css" >
2024-11-26 22:42:53 +00:00
< link rel = "stylesheet" href = "fonts/fonts.css" >
2022-04-18 12:58:41 +00:00
<!-- 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 -->
2024-11-26 22:42:53 +00:00
2022-04-18 12:58:41 +00:00
<!-- Provide site root to javascript -->
2024-11-26 22:42:53 +00:00
< script >
2022-04-18 12:58:41 +00:00
var path_to_root = "";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
< / script >
2024-11-26 22:42:53 +00:00
<!-- Start loading toc.js asap -->
< script src = "toc.js" > < / script >
< / head >
< body >
< div id = "body-container" >
2022-04-18 12:58:41 +00:00
<!-- Work around some values being stored in localStorage wrapped in quotes -->
2024-11-26 22:42:53 +00:00
< script >
2022-04-18 12:58:41 +00:00
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 -->
2024-11-26 22:42:53 +00:00
< script >
2022-04-18 12:58:41 +00:00
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
2024-11-26 22:42:53 +00:00
const html = document.documentElement;
2022-04-18 12:58:41 +00:00
html.classList.remove('light')
html.classList.add(theme);
2024-11-26 22:42:53 +00:00
html.classList.add("js");
2022-04-18 12:58:41 +00:00
< / script >
2024-11-26 22:42:53 +00:00
< input type = "checkbox" id = "sidebar-toggle-anchor" class = "hidden" >
2022-04-18 12:58:41 +00:00
<!-- Hide / unhide sidebar before it is displayed -->
2024-11-26 22:42:53 +00:00
< script >
var sidebar = null;
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
2022-04-18 12:58:41 +00:00
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
2024-11-26 22:42:53 +00:00
} else {
sidebar = 'hidden';
2022-04-18 12:58:41 +00:00
}
2024-11-26 22:42:53 +00:00
sidebar_toggle.checked = sidebar === 'visible';
2022-04-18 12:58:41 +00:00
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
< / script >
< nav id = "sidebar" class = "sidebar" aria-label = "Table of contents" >
2024-11-26 22:42:53 +00:00
<!-- populated by js -->
< mdbook-sidebar-scrollbox class = "sidebar-scrollbox" > < / mdbook-sidebar-scrollbox >
< noscript >
< iframe class = "sidebar-iframe-outer" src = "toc.html" > < / iframe >
< / noscript >
< div id = "sidebar-resize-handle" class = "sidebar-resize-handle" >
< div class = "sidebar-resize-indicator" > < / div >
< / div >
2022-04-18 12:58:41 +00:00
< / nav >
< div id = "page-wrapper" class = "page-wrapper" >
< div class = "page" >
< div id = "menu-bar-hover-placeholder" > < / div >
2024-11-26 22:42:53 +00:00
< div id = "menu-bar" class = "menu-bar sticky" >
2022-04-18 12:58:41 +00:00
< div class = "left-buttons" >
2024-11-26 22:42:53 +00:00
< label id = "sidebar-toggle" class = "icon-button" for = "sidebar-toggle-anchor" title = "Toggle Table of Contents" aria-label = "Toggle Table of Contents" aria-controls = "sidebar" >
2022-04-18 12:58:41 +00:00
< i class = "fa fa-bars" > < / i >
2024-11-26 22:42:53 +00:00
< / label >
2022-04-18 12:58:41 +00:00
< 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" >
2024-11-26 22:42:53 +00:00
< li role = "none" > < button role = "menuitem" class = "theme" id = "light" > Light< / button > < / li >
2022-04-18 12:58:41 +00:00
< 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 >
2024-11-26 22:42:53 +00:00
< 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" >
2022-04-18 12:58:41 +00:00
< i class = "fa fa-search" > < / i >
< / button >
2024-11-26 22:42:53 +00:00
< / div >
2022-04-18 12:58:41 +00:00
< h1 class = "menu-title" > Rules ForeignCc< / h1 >
< div class = "right-buttons" >
2024-11-26 22:42:53 +00:00
< a href = "print.html" title = "Print this book" aria-label = "Print this book" >
2022-04-18 12:58:41 +00:00
< i id = "print-button" class = "fa fa-print" > < / i >
< / a >
2024-11-26 22:42:53 +00:00
< a href = "https://github.com/bazelbuild/rules_foreign_cc" title = "Git repository" aria-label = "Git repository" >
2022-04-18 12:58:41 +00:00
< i id = "git-repository-button" class = "fa fa-github" > < / i >
< / a >
2024-11-26 22:42:53 +00:00
2022-04-18 12:58:41 +00:00
< / div >
< / div >
2024-11-26 22:42:53 +00:00
< div id = "search-wrapper" class = "hidden" >
2022-04-18 12:58:41 +00:00
< 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 >
2024-11-26 22:42:53 +00:00
2022-04-18 12:58:41 +00:00
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
2024-11-26 22:42:53 +00:00
< script >
2022-04-18 12:58:41 +00:00
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 >
2024-11-26 22:42:53 +00:00
< div class = "table-wrapper" > < table > < thead > < tr > < th > Release< / th > < th > Commit< / th > < th > Status< / th > < / tr > < / thead > < tbody >
2022-04-18 12:58:41 +00:00
< tr > < td > 0.8.0< / td > < td > < a href = "https://github.com/bazelbuild/rules_foreign_cc/commit/e208deeae394c2aba5531d1f4edbba82d2e7430c" > e208dee< / 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 >
2024-11-26 22:42:53 +00:00
< / div >
2022-04-18 12:58:41 +00:00
< 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 >
2024-11-26 22:42:53 +00:00
< pre > < code class = "language-python" > load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
2022-04-18 12:58:41 +00:00
http_archive(
2024-11-26 22:42:53 +00:00
name = "rules_foreign_cc",
2022-04-18 12:58:41 +00:00
# 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
#
2024-11-26 22:42:53 +00:00
# sha256 = "...",
strip_prefix = "rules_foreign_cc-0.8.0",
url = "https://github.com/bazelbuild/rules_foreign_cc/archive/0.8.0.tar.gz",
2022-04-18 12:58:41 +00:00
)
2024-11-26 22:42:53 +00:00
load("@rules_foreign_cc//foreign_cc:repositories.bzl", "rules_foreign_cc_dependencies")
2022-04-18 12:58:41 +00:00
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 >
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
2024-11-26 22:42:53 +00:00
< a rel = "next prefetch" href = "rules.html" class = "mobile-nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
2022-04-18 12:58:41 +00:00
< i class = "fa fa-angle-right" > < / i >
< / a >
2024-11-26 22:42:53 +00:00
2022-04-18 12:58:41 +00:00
< div style = "clear: both" > < / div >
< / nav >
< / div >
< / div >
< nav class = "nav-wide-wrapper" aria-label = "Page navigation" >
2024-11-26 22:42:53 +00:00
< a rel = "next prefetch" href = "rules.html" class = "nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
2022-04-18 12:58:41 +00:00
< i class = "fa fa-angle-right" > < / i >
< / a >
2024-11-26 22:42:53 +00:00
< / nav >
2022-04-18 12:58:41 +00:00
< / div >
2024-11-26 22:42:53 +00:00
< script >
2022-04-18 12:58:41 +00:00
window.playground_copyable = true;
< / script >
2024-11-26 22:42:53 +00:00
< script src = "elasticlunr.min.js" > < / script >
< script src = "mark.min.js" > < / script >
< script src = "searcher.js" > < / script >
< script src = "clipboard.min.js" > < / script >
< script src = "highlight.js" > < / script >
< script src = "book.js" > < / script >
2022-04-18 12:58:41 +00:00
<!-- Custom JS scripts -->
2024-11-26 22:42:53 +00:00
< / div >
2022-04-18 12:58:41 +00:00
< / body >
< / html >
