| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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"/>
- <title>cbuild.sh: Build Invocation</title>
- <title>CMSIS-Build: cbuild.sh: Build Invocation</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <link href="cmsis.css" rel="stylesheet" type="text/css" />
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <script type="text/javascript" src="printComponentTabs.js"></script>
- <link href="navtree.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="resize.js"></script>
- <script type="text/javascript" src="navtree.js"></script>
- <script type="text/javascript">
- $(document).ready(initResizable);
- $(window).load(resizeHeight);
- </script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/search.js"></script>
- <script type="text/javascript">
- $(document).ready(function() { searchBox.OnSelectItem(0); });
- </script>
- </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: 46px;">
- <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
- <td style="padding-left: 0.5em;">
- <div id="projectname">CMSIS-Build
-  <span id="projectnumber">Version 0.9.0 (beta)</span>
- </div>
- <div id="projectbrief">Tools, software frameworks, and work flows for productivity with CMSIS based projects</div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <div id="CMSISnav" class="tabs1">
- <ul class="tablist">
- <script type="text/javascript">
- <!--
- writeComponentTabs.call(this);
- //-->
- </script>
- </ul>
- </div>
- <!-- Generated by Doxygen 1.8.6 -->
- <script type="text/javascript">
- var searchBox = new SearchBox("searchBox", "search",false,'Search');
- </script>
- <div id="navrow1" class="tabs">
- <ul class="tablist">
- <li><a href="index.html"><span>Main Page</span></a></li>
- <li class="current"><a href="pages.html"><span>Usage and Description</span></a></li>
- <li>
- <div id="MSearchBox" class="MSearchBoxInactive">
- <span class="left">
- <img id="MSearchSelect" src="search/mag_sel.png"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- alt=""/>
- <input type="text" id="MSearchField" value="Search" accesskey="S"
- onfocus="searchBox.OnSearchFieldFocus(true)"
- onblur="searchBox.OnSearchFieldFocus(false)"
- onkeyup="searchBox.OnSearchFieldChange(event)"/>
- </span><span class="right">
- <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
- </span>
- </div>
- </li>
- </ul>
- </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">
- $(document).ready(function(){initNavTree('cbuild.html','');});
- </script>
- <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)">
- <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Pages</a></div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <iframe src="javascript:void(0)" frameborder="0"
- name="MSearchResults" id="MSearchResults">
- </iframe>
- </div>
- <div class="header">
- <div class="headertitle">
- <div class="title">cbuild.sh: Build Invocation </div> </div>
- </div><!--header-->
- <div class="contents">
- <div class="textblock"><p>The <a class="el" href="cbuild.html">cbuild.sh</a> script starts the build process. It is called from the <b>Bash</b> command line with the following syntax:</p>
- <div class="fragment"><div class="line">$ cbuild.sh <ProjectFile>.cprj [--toolchain=<Toolchain> --output=<OutputPath> <MakefileTarget>]</div>
- </div><!-- fragment --><p><b>Where:</b> </p>
- <p><code>cbuild.sh</code> is the name of the script.</p>
- <p><<code>ProjectFile></code> specifies the project file in CMSIS project format.</p>
- <p>Optional:</p>
- <p><<code>Toolchain></code> specifies the selected toolchain for projects that support multiple compilers.</p>
- <p><<code>OutputPath></code> specifies the output directory.</p>
- <p><<code>MakefileTarget></code> specifies the <<code>target></code> option for <a class="el" href="Make.html">make</a>.</p>
- <p>The <a class="el" href="cbuild.html">cbuild.sh: Build Invocation</a> script implements the build flow by chaining the utilities <a class="el" href="cbuildgen.html">cbuildgen</a>, <a class="el" href="ccmerge.html">ccmerge</a>, and <b>Make</b>. It replicates the build steps of CMSIS-Pack aware IDEs and also updates configuration files if necessary. The script can be adopted to project specific requirements.</p>
- <p>The build flow of the <a class="el" href="cbuild.html">cbuild.sh: Build Invocation</a> script is:</p>
- <ol type="1">
- <li>Call <a class="el" href="cbuildgen.html">cbuildgen: Build Process Manager</a> with command <b>packlist</b> to list the URLs of missing software packs.</li>
- <li>Call <a class="el" href="cp_install.html">cp_install.sh: Install Packs</a> to download and install missing software packs.</li>
- <li>Call <a class="el" href="cbuildgen.html">cbuildgen: Build Process Manager</a> with command <b>make</b> to generate Make files.</li>
- <li>Call <a class="el" href="Make.html">make: GNU Make</a> to update configuration files using <a class="el" href="ccmerge.html">ccmerge: Config File Updater</a>.</li>
- <li>Call <a class="el" href="Make.html">make: GNU Make</a> to compile the project source code into the binary image.</li>
- </ol>
- <h1><a class="anchor" id="cbuild_example"></a>
- Usage Example</h1>
- <pre class="fragment">$ cbuild.sh Simulation.cprj
- (cbuild.sh): Build Invocation 0.9.0 (C) 2020 ARM
- Simulation.cprj validates
- (cbuildgen): Build Process Manager 0.9.0 (C) 2020 ARM
- M650: Config command completed successfully.
- (cbuildgen): Build Process Manager 0.9.0 (C) 2020 ARM
- M651: Generated makefile for merging config files: 'Simulation_cfg.mak'
- M652: Generated makefile for project build:'Simulation.mak'
- mkdir -p "/c/Examples/Blinky/Objects/RTE/CMSIS/RTOS2/Keil RTX5/Library"
- mkdir -p "/c/Examples/Blinky/Objects/RTE/Compiler/IO/STDOUT/ITM"
- mkdir -p "/c/Examples/Blinky/Objects/RTE/Device/Startup/C Startup"
- mkdir -p "/c/Examples/Blinky/Objects/Source Files"
- "/C/Keil_v5/ARM/ARMCLANG/bin/armclang" @"/c/Examples/Blinky/Objects/RTE/CMSIS/RTOS2/Keil RTX5/Library/RTX_Config.o._cc"
- "/C/Keil_v5/ARM/ARMCLANG/bin/armclang" @"/c/Examples/Blinky/Objects/RTE/CMSIS/RTOS2/Keil RTX5/Library/rtx_lib.o._cc"
- "/C/Keil_v5/ARM/ARMCLANG/bin/armclang" @"/c/Examples/Blinky/Objects/RTE/Compiler/IO/STDOUT/ITM/retarget_io.o._cc"
- "/C/Keil_v5/ARM/ARMCLANG/bin/armclang" @"/c/Examples/Blinky/Objects/RTE/Device/Startup/C Startup/startup_ARMCM3.o._cc"
- "/C/Keil_v5/ARM/ARMCLANG/bin/armclang" @"/c/Examples/Blinky/Objects/RTE/Device/Startup/C Startup/system_ARMCM3.o._cc"
- "/C/Keil_v5/ARM/ARMCLANG/bin/armclang" @"/c/Examples/Blinky/Objects/Source Files/Blinky.o._cc"
- "/C/Keil_v5/ARM/ARMCLANG/bin/armlink" --via="/c/Examples/Blinky/Objects/Blinky.axf._ld"
- Program Size: Code=7516 RO-data=1264 RW-data=168 ZI-data=9084
- cbuild.sh finished successfully!
- </pre><h1><a class="anchor" id="cbuild_errors"></a>
- Error Messages</h1>
- <table class="cmtable" summary="cbuild messages">
- <tr>
- <th>Type </th><th>Message </th><th>Action </th></tr>
- <tr>
- <td>ERROR </td><td>error: missing required argument <<code>project></code>.cprj </td><td>See usage and correct the argument. </td></tr>
- <tr>
- <td>ERROR </td><td>error: CMSIS_BUILD_ROOT environment variable not set </td><td>Set <a class="el" href="cbuild_install.html#cbuild_envsetup">Environment Variables</a>. </td></tr>
- <tr>
- <td>ERROR </td><td>make ${output}${project}_cfg.mak failed! </td><td>Check make error messages. </td></tr>
- <tr>
- <td>ERROR </td><td>make ${output}${project}.mak failed! </td><td>Check make error messages. </td></tr>
- <tr>
- <td>INFO </td><td>cbuild.sh finished successfully! </td><td>For information only. </td></tr>
- </table>
- </div></div><!-- contents -->
- </div><!-- doc-content -->
- <!-- start footer part -->
- <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
- <ul>
- <li class="navelem"><a class="el" href="CmdLineBuild.html">Command Line Build</a></li>
- <li class="footer">Generated on Thu Apr 9 2020 15:49:55 for CMSIS-Build Version 0.9.0 (beta) by Arm Ltd. All rights reserved.
- <!--
- <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
- -->
- </li>
- </ul>
- </div>
- </body>
- </html>
|