173 lines
9.5 KiB
HTML
173 lines
9.5 KiB
HTML
<!-- HTML header for doxygen 1.9.1-->
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.15.0"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>L4Re Operating System Framework: L4Re Build System</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="cookie.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|
<link href="l4re-awesome.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="L4Re_rgb_logo_quer_hg_h55.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">L4Re Operating System Framework
|
|
</div>
|
|
<div id="projectbrief">Interface and Usage Documentation</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.15.0 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
</script>
|
|
<script type="text/javascript">
|
|
$(function() { codefold.init(); });
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',true);
|
|
$(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(function(){initNavTree('l4re_build_system.html','',''); });
|
|
</script>
|
|
<div id="container">
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div><div class="header">
|
|
<div class="headertitle"><div class="title">L4Re Build System </div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><p><a class="el" href="namespaceL4Re.html" title="L4Re C++ Interfaces.">L4Re</a> uses a custom make-based build system, often simply referred to as <em>BID</em>. This section explains how to use BID when writing applications and libraries for <a class="el" href="namespaceL4Re.html" title="L4Re C++ Interfaces.">L4Re</a>.</p>
|
|
<h1 class="doxsection"><a class="anchor" id="l4re_build_system_using"></a>
|
|
Building L4Re</h1>
|
|
<h2>Setting up the Build Directory </h2>
|
|
<p><a class="el" href="namespaceL4Re.html" title="L4Re C++ Interfaces.">L4Re</a> must be built out-of-source. Therefore the first mandatory step is creating and populating a build directory. From the root of the <a class="el" href="namespaceL4Re.html" title="L4Re C++ Interfaces.">L4Re</a> source tree run </p><pre class="fragment">make B=<builddir>
|
|
</pre><p>Other targets that can be executed in the source directory are</p>
|
|
<dl class="section user"><dt>update</dt><dd>Update the source directory from svn. Only makes sense when you have downloaded <a class="el" href="namespaceL4Re.html" title="L4Re C++ Interfaces.">L4Re</a> from the official subversion repository.</dd></dl>
|
|
<dl class="section user"><dt>help</dt><dd>Show a short help with the most important targets.</dd></dl>
|
|
<h2>Invoking Make </h2>
|
|
<p>Once the build directory is set up, BID make can be invoked in one of two ways:</p>
|
|
<ol type="1">
|
|
<li>Go to the build directory and invoke make without special options.</li>
|
|
<li>Go to a source directory with a BID make file and invoke <span class="tt">make O=<builddir> ...</span>.</li>
|
|
</ol>
|
|
<p>The default target builds the source (as you would expect), other targets that are available in build mode are</p>
|
|
<dl class="section user"><dt>cleanfast</dt><dd>Quickly cleans the build directory by removing all subdirectories that contain generated files. The configuration will remain untouched.</dd></dl>
|
|
<dl class="section user"><dt>clean</dt><dd>Remove generated files. Slower than <span class="tt">make cleanfast</span> but can be used on selected packages. Use <span class="tt">S=...</span> to select the target package.</dd></dl>
|
|
<p>In addition to these targets, there are a number of targets to generate images which are explained elsewhere.</p>
|
|
<h1 class="doxsection"><a class="anchor" id="l4re_build_system_writing"></a>
|
|
Writing BID Make Files</h1>
|
|
<p>The BID build system exports different roles that define what should be done in the subdirectory. So a BID make file essentially consists of defining the role and a number of role-dependent make variables. The basic layout should look like this:</p>
|
|
<div class="fragment"><div class="line">PKGDIR ?= <path to package<span class="stringliteral">'s root directory> # e.g., '</span>.<span class="stringliteral">' or '</span>..<span class="stringliteral">'</span></div>
|
|
<div class="line"><span class="stringliteral">L4DIR ?= <path to L4Re source directory> # e.g. '</span>$(PKGDIR)/../..<span class="stringliteral">'</span></div>
|
|
<div class="line"><span class="stringliteral"></span> </div>
|
|
<div class="line"><span class="stringliteral"><various definitions></span></div>
|
|
<div class="line"><span class="stringliteral"></span> </div>
|
|
<div class="line"><span class="stringliteral">include $(L4DIR)/mk/<role>.mk</span></div>
|
|
</div><!-- fragment --><p><span class="tt">PKGDIR</span> in the first line defines the root directory of the current package. <span class="tt">L4DIR</span> in the next line must be pointed to the root of the <a class="el" href="namespaceL4Re.html" title="L4Re C++ Interfaces.">L4Re</a> source tree the package should be built against. After this custom variable definitions for the role follow. In the final line of the file, the make file with the role-specific rules must be sourced.</p>
|
|
<p>The following roles are currently defined:</p>
|
|
<ul>
|
|
<li>project.mk - Sub-project Role</li>
|
|
<li>subdir.mk - Directory Role</li>
|
|
<li><a class="el" href="bid_role_prog.html">prog.mk - Application Role</a></li>
|
|
<li>lib.mk - Library Role</li>
|
|
<li><a class="el" href="bid_role_include.html">include.mk - Header File Role</a></li>
|
|
<li>doc.mk - Documentation Role</li>
|
|
<li><a class="el" href="bid_role_test.html">test.mk - Test Application Role</a></li>
|
|
<li>idl.mk - IDL File Role (currently unused)</li>
|
|
<li>runux.mk - Tests in FiascoUX Role</li>
|
|
</ul>
|
|
<h2>BID-global Variables </h2>
|
|
<p>This section lists variables that configure how the BID build system behaves. They are applicable for all roles.</p>
|
|
<table class="markdownTable">
|
|
<tr class="markdownTableHead">
|
|
<th class="markdownTableHeadNone">Variable </th><th class="markdownTableHeadNone">Description </th></tr>
|
|
<tr class="markdownTableRowOdd">
|
|
<td class="markdownTableBodyNone">CC </td><td class="markdownTableBodyNone">C compiler for target </td></tr>
|
|
<tr class="markdownTableRowEven">
|
|
<td class="markdownTableBodyNone">CXX </td><td class="markdownTableBodyNone">C++ compiler for target </td></tr>
|
|
<tr class="markdownTableRowOdd">
|
|
<td class="markdownTableBodyNone">HOST_CC </td><td class="markdownTableBodyNone">C compiler for host </td></tr>
|
|
<tr class="markdownTableRowEven">
|
|
<td class="markdownTableBodyNone">HOST_CXX </td><td class="markdownTableBodyNone">C++ compiler for host </td></tr>
|
|
</table>
|
|
</div></div><!-- contents -->
|
|
</div><!-- PageDoc -->
|
|
</div><!-- doc-content -->
|
|
<div id="page-nav" class="page-nav-panel">
|
|
<div id="page-nav-resize-handle"></div>
|
|
<div id="page-nav-tree">
|
|
<div id="page-nav-contents">
|
|
</div><!-- page-nav-contents -->
|
|
</div><!-- page-nav-tree -->
|
|
</div><!-- page-nav -->
|
|
</div><!-- container -->
|
|
<!-- HTML footer for doxygen 1.9.1-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a href="l4re_concepts.html">Programming for L4Re</a></li>
|
|
<li class="footer">Generated on <span class="timestamp"></span> for L4Re Operating System Framework by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|