element_files.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <title>/cprj/files</title>
  7. <title>CMSIS-Build: /cprj/files</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <link href="cmsis.css" rel="stylesheet" type="text/css" />
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <script type="text/javascript" src="printComponentTabs.js"></script>
  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14. <script type="text/javascript" src="resize.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript">
  17. $(document).ready(initResizable);
  18. $(window).load(resizeHeight);
  19. </script>
  20. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21. <script type="text/javascript" src="search/search.js"></script>
  22. <script type="text/javascript">
  23. $(document).ready(function() { searchBox.OnSelectItem(0); });
  24. </script>
  25. </head>
  26. <body>
  27. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  28. <div id="titlearea">
  29. <table cellspacing="0" cellpadding="0">
  30. <tbody>
  31. <tr style="height: 46px;">
  32. <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  33. <td style="padding-left: 0.5em;">
  34. <div id="projectname">CMSIS-Build
  35. &#160;<span id="projectnumber">Version 0.9.0 (beta)</span>
  36. </div>
  37. <div id="projectbrief">Tools, software frameworks, and work flows for productivity with CMSIS based projects</div>
  38. </td>
  39. </tr>
  40. </tbody>
  41. </table>
  42. </div>
  43. <!-- end header part -->
  44. <div id="CMSISnav" class="tabs1">
  45. <ul class="tablist">
  46. <script type="text/javascript">
  47. <!--
  48. writeComponentTabs.call(this);
  49. //-->
  50. </script>
  51. </ul>
  52. </div>
  53. <!-- Generated by Doxygen 1.8.6 -->
  54. <script type="text/javascript">
  55. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  56. </script>
  57. <div id="navrow1" class="tabs">
  58. <ul class="tablist">
  59. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  60. <li class="current"><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
  61. <li>
  62. <div id="MSearchBox" class="MSearchBoxInactive">
  63. <span class="left">
  64. <img id="MSearchSelect" src="search/mag_sel.png"
  65. onmouseover="return searchBox.OnSearchSelectShow()"
  66. onmouseout="return searchBox.OnSearchSelectHide()"
  67. alt=""/>
  68. <input type="text" id="MSearchField" value="Search" accesskey="S"
  69. onfocus="searchBox.OnSearchFieldFocus(true)"
  70. onblur="searchBox.OnSearchFieldFocus(false)"
  71. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  72. </span><span class="right">
  73. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  74. </span>
  75. </div>
  76. </li>
  77. </ul>
  78. </div>
  79. </div><!-- top -->
  80. <div id="side-nav" class="ui-resizable side-nav-resizable">
  81. <div id="nav-tree">
  82. <div id="nav-tree-contents">
  83. <div id="nav-sync" class="sync"></div>
  84. </div>
  85. </div>
  86. <div id="splitbar" style="-moz-user-select:none;"
  87. class="ui-resizable-handle">
  88. </div>
  89. </div>
  90. <script type="text/javascript">
  91. $(document).ready(function(){initNavTree('element_files.html','');});
  92. </script>
  93. <div id="doc-content">
  94. <!-- window showing the filter options -->
  95. <div id="MSearchSelectWindow"
  96. onmouseover="return searchBox.OnSearchSelectShow()"
  97. onmouseout="return searchBox.OnSearchSelectHide()"
  98. onkeydown="return searchBox.OnSearchSelectKey(event)">
  99. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  100. <!-- iframe showing the search results (closed by default) -->
  101. <div id="MSearchResultsWindow">
  102. <iframe src="javascript:void(0)" frameborder="0"
  103. name="MSearchResults" id="MSearchResults">
  104. </iframe>
  105. </div>
  106. <div class="header">
  107. <div class="headertitle">
  108. <div class="title">/cprj/files </div> </div>
  109. </div><!--header-->
  110. <div class="contents">
  111. <div class="textblock"><p>The files section specifies files to be included into the project build that are not managed through software components. Files can be associated with a named group. Grouping is mainly for better visualization in a graphical tool, however commandline flags can also be applied on a group level.</p>
  112. <p><b>Example</b> <em>files</em> section: </p>
  113. <div class="fragment"><div class="line">&lt;cprj xmlns:xsi=<span class="stringliteral">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span> xsi:noNamespaceSchemaLocation=<span class="stringliteral">&quot;CPRJ.xsd&quot;</span>/&gt;</div>
  114. <div class="line"> ...</div>
  115. <div class="line"> &lt;components&gt;</div>
  116. <div class="line"> ...</div>
  117. <div class="line"> &lt;/components&gt;</div>
  118. <div class="line"> &lt;files&gt;</div>
  119. <div class="line"> &lt;group name=<span class="stringliteral">&quot;Source Files&quot;</span>&gt;</div>
  120. <div class="line"> &lt;file category=<span class="stringliteral">&quot;sourceC&quot;</span> name=<span class="stringliteral">&quot;./Blinky.c&quot;</span>/&gt;</div>
  121. <div class="line"> &lt;file category=<span class="stringliteral">&quot;sourceC&quot;</span> name=<span class="stringliteral">&quot;./Thread_LED.c&quot;</span>/&gt;</div>
  122. <div class="line"> &lt;/group&gt;</div>
  123. <div class="line"> &lt;group name=<span class="stringliteral">&quot;Documentation&quot;</span>&gt;</div>
  124. <div class="line"> &lt;file category=<span class="stringliteral">&quot;doc&quot;</span> name=<span class="stringliteral">&quot;./Abstract.txt&quot;</span>/&gt;</div>
  125. <div class="line"> &lt;/group&gt;</div>
  126. <div class="line"> &lt;/files&gt;</div>
  127. <div class="line">&lt;/cprj&gt;</div>
  128. </div><!-- fragment --><p> <br/>
  129. </p>
  130. <table class="cmtable" summary="Element: files">
  131. <tr>
  132. <th>Parents </th><th colspan="3">Element Chain </th></tr>
  133. <tr>
  134. <td><a class="el" href="element_cprj.html">cprj</a> </td><td colspan="3"><a class="el" href="element_cprj.html">/cprj</a> </td></tr>
  135. <tr>
  136. <th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr>
  137. <tr>
  138. <td><a class="el" href="element_files.html#element_project_file">file</a> </td><td>Specify a file. </td><td>FileType </td><td>0..* </td></tr>
  139. <tr>
  140. <td><a class="el" href="element_files.html#element_group">group</a> </td><td>Specify a group name and list member files in subelements. </td><td>GroupType </td><td>0..* </td></tr>
  141. </table>
  142. <p>&#160;</p>
  143. <hr/>
  144. <h1><a class="anchor" id="element_group"></a>
  145. /cprj/files/.../group</h1>
  146. <p>The description format allows the nesting of groups. It is up to the tool's implementation how grouping is represented in the user interface. The grouping of files only impacts the build, if the assignment of command line options on a group level is supported.</p>
  147. <p><b>Example</b> <em>files</em> section: </p>
  148. <div class="fragment"><div class="line">&lt;cprj xmlns:xsi=<span class="stringliteral">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span> xsi:noNamespaceSchemaLocation=<span class="stringliteral">&quot;CPRJ.xsd&quot;</span>/&gt;</div>
  149. <div class="line"> ...</div>
  150. <div class="line"> &lt;files&gt;</div>
  151. <div class="line"> &lt;group name=<span class="stringliteral">&quot;Source&quot;</span>&gt;</div>
  152. <div class="line"> &lt;group name=<span class="stringliteral">&quot;C&quot;</span>&gt;</div>
  153. <div class="line"> &lt;cflags add=<span class="stringliteral">&quot;-D_MY_DEFINE&quot;</span>/&gt;</div>
  154. <div class="line"> &lt;file category=<span class="stringliteral">&quot;sourceC&quot;</span> name=<span class="stringliteral">&quot;./Blinky.c&quot;</span>/&gt;</div>
  155. <div class="line"> &lt;file category=<span class="stringliteral">&quot;sourceC&quot;</span> name=<span class="stringliteral">&quot;./Thread_LED.c&quot;</span>/&gt;</div>
  156. <div class="line"> &lt;/group&gt;</div>
  157. <div class="line"> &lt;group name=<span class="stringliteral">&quot;ASM&quot;</span>&gt;</div>
  158. <div class="line"> &lt;file category=<span class="stringliteral">&quot;sourceAsm&quot;</span> name=<span class="stringliteral">&quot;./startup_add.s&quot;</span>/&gt;</div>
  159. <div class="line"> &lt;/group&gt;</div>
  160. <div class="line"> &lt;/group&gt;</div>
  161. <div class="line"> &lt;group name=<span class="stringliteral">&quot;Documentation&quot;</span>&gt;</div>
  162. <div class="line"> &lt;file category=<span class="stringliteral">&quot;doc&quot;</span> name=<span class="stringliteral">&quot;./Abstract.txt&quot;</span>/&gt;</div>
  163. <div class="line"> &lt;/group&gt;</div>
  164. <div class="line"> &lt;/files&gt;</div>
  165. <div class="line">&lt;/cprj&gt;</div>
  166. </div><!-- fragment --><p> <br/>
  167. </p>
  168. <table class="cmtable" summary="Element: group">
  169. <tr>
  170. <th>Parents </th><th colspan="3">Element Chain </th></tr>
  171. <tr>
  172. <td><a class="el" href="element_files.html">files</a> </td><td colspan="3"><a class="el" href="element_files.html">/cprj/files</a> </td></tr>
  173. <tr>
  174. <th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
  175. <tr>
  176. <td>name </td><td>name of the group of files </td><td><a class="el" href="cprj_types.html#type_restrictedStringType">RestrictedString</a> </td><td>required </td></tr>
  177. <tr>
  178. <th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr>
  179. <tr>
  180. <td><a class="el" href="element_files.html#element_project_file">file</a> </td><td>Specify a file. </td><td>FileType </td><td>0..* </td></tr>
  181. <tr>
  182. <td><a class="el" href="element_files.html#element_group">group</a> </td><td>Specify a group (nesting). </td><td>GroupType </td><td>0..* </td></tr>
  183. </table>
  184. <p>&#160;</p>
  185. <hr/>
  186. <h1><a class="anchor" id="element_group_cflags"></a>
  187. /cprj/files/group/.../cflags</h1>
  188. <p>These compiler options are either added or removed from the inherited command line and affect all C-modules that belong to the file group. This flag can also be added to components and individual files within the description.</p>
  189. <p>See: <a class="el" href="element_components.html#element_cflags">/cprj/components/component/cflags</a></p>
  190. <p>&#160;</p>
  191. <hr/>
  192. <h1><a class="anchor" id="element_group_cxxflags"></a>
  193. /cprj/files/group/.../cxxflags</h1>
  194. <p>These compiler options are either added or removed from the inherited command line and affect all C++-modules that belong to the file group. This flag can also be added to components and individual files within the description.</p>
  195. <p>See: <a class="el" href="element_components.html#element_cxxflags">/cprj/components/component/cxxflags</a></p>
  196. <p>&#160;</p>
  197. <hr/>
  198. <h1><a class="anchor" id="element_group_asflags"></a>
  199. /cprj/files/group/.../asflags</h1>
  200. <p>These assembler options are either added or removed from the inherited command line and affect all Assembler modules that belong to the file group. This flag can also be added to components and individual files within the description.</p>
  201. <p>See: <a class="el" href="element_components.html#element_asflags">/cprj/components/component/asflags</a></p>
  202. <p>&#160;</p>
  203. <hr/>
  204. <h1><a class="anchor" id="element_project_file"></a>
  205. /cprj/files/.../file</h1>
  206. <p>Specify files that are not included through software components.</p>
  207. <table class="cmtable" summary="Element: file">
  208. <tr>
  209. <th>Parents </th><th colspan="3">Element Chain </th></tr>
  210. <tr>
  211. <td><a class="el" href="element_files.html">files</a> </td><td colspan="3"><a class="el" href="element_files.html">/cprj/files</a> </td></tr>
  212. <tr>
  213. <td><a class="el" href="element_files.html#element_group">group</a> </td><td colspan="3"><a class="el" href="element_files.html#element_group">/cprj/files/.../group</a> </td></tr>
  214. <tr>
  215. <th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
  216. <tr>
  217. <td>name </td><td>Path and name of the file, relative to location of the project file. </td><td>xs:string </td><td>required </td></tr>
  218. <tr>
  219. <td>category </td><td>Type of file, for example, whether the file is a C or assembler file. Use the predefined values from the table <a class="el" href="cprj_types.html#FileCategoryEnum">File Categories</a>. </td><td>FileCategoryType </td><td>required </td></tr>
  220. <tr>
  221. <td>src </td><td>Folder specifying the source code location for a library if included in a subdirectory. </td><td>xs:string </td><td>optional </td></tr>
  222. </table>
  223. <p>&#160;</p>
  224. <hr/>
  225. <h1><a class="anchor" id="element_file_cflags"></a>
  226. /cprj/files/.../file/cflags</h1>
  227. <p>These compiler options are either added or removed from the inherited command line and affect the C-modules that is referenced by the file. This flag can also be added to components and file groups within the description. Note: if the file category attribute is anything but 'sourceC' or 'source' and the file's extension is *.c, the element will be ignored.</p>
  228. <p>See: <a class="el" href="element_components.html#element_cflags">/cprj/components/component/cflags</a></p>
  229. <p>&#160;</p>
  230. <hr/>
  231. <h1><a class="anchor" id="element_file_cxxflags"></a>
  232. /cprj/files/.../file/cxxflags</h1>
  233. <p>These compiler options are either added or removed from the inherited command line and affect the C++-modules that is referenced by the file. This flag can also be added to components and file groups within the description. Note: if the file category attribute is anything but 'sourceCpp' or 'source' and the file extension is *.cpp, the flag will be ignored.</p>
  234. <p>See: <a class="el" href="element_components.html#element_cxxflags">/cprj/components/component/cxxflags</a></p>
  235. <p>&#160;</p>
  236. <hr/>
  237. <h1><a class="anchor" id="element_file_asflags"></a>
  238. /cprj/files/.../file/asflags</h1>
  239. <p>These assembler options are either added or removed from the inherited command line and affect the Assembler module that is referenced by the file. This flag can also be added to components and file groups within the description. Note: if the file category attribute is anything but 'sourceAsm' or 'source' and the file extension is *.s, the flag will be ignored.</p>
  240. <p>See: <a class="el" href="element_components.html#element_asflags">/cprj/components/component/asflags</a></p>
  241. <p>&#160;</p>
  242. <hr/>
  243. </div></div><!-- contents -->
  244. </div><!-- doc-content -->
  245. <!-- start footer part -->
  246. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  247. <ul>
  248. <li class="navelem"><a class="el" href="cprjFormat_pg.html">Project Description (*.cprj) Format</a></li><li class="navelem"><a class="el" href="element_cprj.html">/cprj</a></li>
  249. <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.
  250. <!--
  251. <a href="http://www.doxygen.org/index.html">
  252. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  253. -->
  254. </li>
  255. </ul>
  256. </div>
  257. </body>
  258. </html>