cp_install.html 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195
  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>cp_install.sh: Install Packs</title>
  7. <title>CMSIS-Build: cp_install.sh: Install Packs</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('cp_install.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">cp_install.sh: Install Packs </div> </div>
  109. </div><!--header-->
  110. <div class="contents">
  111. <div class="textblock"><p>The <code>cp_install</code> "cp_install.sh" script gets a list of URLs that refer to software packs in CMSIS-Pack format that should be downloaded and installed. It is called from the <b>Bash</b> command line with the following syntax:</p>
  112. <div class="fragment"><div class="line">cp_install.sh &lt;pack-list-file&gt; </div>
  113. </div><!-- fragment --><p><b>Where:</b></p>
  114. <p><code>cp_install</code> is the name of the script.</p>
  115. <p>&lt;<code>pack-list-file&gt;</code> is a text file that contains a URL list.</p>
  116. <p>The <code>cp_install</code> script reads a text file that contains a URL list of software packs in CMSIS-Pack format. The URL list has the following format: <code>&lt;url&gt;/&lt;vendor&gt;</code>.&lt;packname&gt;.&lt;version&gt;.pack. Below is an example: </p>
  117. <div class="fragment"><div class="line">https:<span class="comment">//www.keil.com/pack/ARM.CMSIS.5.6.0.pack</span></div>
  118. <div class="line">https:<span class="comment">//www.keil.com/pack/ARM.CMSIS-Driver.2.5.0.pack</span></div>
  119. </div><!-- fragment --><p>For each URL in this list the following operations are performed:</p>
  120. <ol type="1">
  121. <li>Download the related software pack from the URL.</li>
  122. <li>Extract the content of the software pack.</li>
  123. </ol>
  124. <p>The following directories are used to store software pack. The naming conventions for directories is based on the CMSIS-Pack specification.</p>
  125. <table class="doxtable">
  126. <tr>
  127. <th align="left">Directory </th><th align="left">Description </th></tr>
  128. <tr>
  129. <td align="left"><b>${CMSIS_PACK_ROOT}/.Download</b> </td><td align="left">Stores the downloaded software pack </td></tr>
  130. <tr>
  131. <td align="left"><b>${CMSIS_PACK_ROOT}/&lt;vendor&gt;/&lt;packname&gt;/&lt;version&gt;</b> </td><td align="left">Extracted content of the software pack (naming accoring CMSIS-Pack specification) </td></tr>
  132. </table>
  133. <dl class="section note"><dt>Note</dt><dd>The environment variable <code>$CMSIS_PACK_ROOT</code> must reference an existing directory with at least the file ./Web/index.pidx. The directory structure can be created with <a class="el" href="cp_init.html">cp_init.sh: Setup Pack Directory</a></dd></dl>
  134. <h1><a class="anchor" id="cp_install_example"></a>
  135. Usage Example</h1>
  136. <pre class="fragment">$
  137. cp_install.sh Simulation.cpinstall
  138. (cp_install.sh): Install Packs 0.9.0 (C) 2020 ARM
  139. info: reading file: Simulation.cpinstall
  140. dos2unix: converting file Simulation.cpinstall to Unix format...
  141. http://www.keil.com/pack/ARM.CMSIS.5.6.0.pack
  142. ######################################################################## 100.0%#=#=#
  143. ######################################################################## 100.0%
  144. info: ARM.CMSIS.5.6.0.pack installing into /c/arm/cbuild/packs/ARM/CMSIS/5.6.0
  145. http://www.keil.com/pack/Keil.ARM_Compiler.1.6.1.pack
  146. ######################################################################## 100.0%#=#=#
  147. ######################################################################## 100.0%
  148. info: Keil.ARM_Compiler.1.6.1.pack installing into /c/arm/cbuild/packs/Keil/ARM_Compiler/1.6.1
  149. pack installation completed successfully
  150. </pre><h1><a class="anchor" id="cp_install_errors"></a>
  151. Error Messages</h1>
  152. <table class="cmtable" summary="cp_install messages">
  153. <tr>
  154. <th>Type </th><th>Message </th><th>Action </th></tr>
  155. <tr>
  156. <td>ERROR </td><td>error: missing command line argument </td><td>See usage and corret argument. </td></tr>
  157. <tr>
  158. <td>ERROR </td><td>error: too many command line arguments </td><td>See usage and corret argument. </td></tr>
  159. <tr>
  160. <td>ERROR </td><td>error: $filename does not exist </td><td>See usage and corret argument. </td></tr>
  161. <tr>
  162. <td>ERROR </td><td>error: CMSIS_PACK_ROOT environment variable not set </td><td>Set <a class="el" href="cbuild_install.html#cbuild_envsetup">Environment Variables</a>. </td></tr>
  163. <tr>
  164. <td>ERROR </td><td>error: CMSIS_PACK_ROOT: folder does not contain package index file .Web/index.pidx </td><td>Check pack repository. </td></tr>
  165. <tr>
  166. <td>ERROR </td><td>error: pack download failed for $pack_url </td><td>Check internet connection and server availability. </td></tr>
  167. <tr>
  168. <td>ERROR </td><td>error: downloaded file $packfile is not a zip/pack file </td><td>Check list of missing packages in cpinstall file. </td></tr>
  169. <tr>
  170. <td>ERROR </td><td>error: unzip failed for $packfile </td><td>Check downloaded package. </td></tr>
  171. <tr>
  172. <td>INFO </td><td>info: pack $packfile is already downloaded </td><td>For information only. </td></tr>
  173. <tr>
  174. <td>INFO </td><td>info: $packfile is already installed </td><td>For information only. </td></tr>
  175. <tr>
  176. <td>INFO </td><td>pack installation completed successfully </td><td>For information only. </td></tr>
  177. </table>
  178. </div></div><!-- contents -->
  179. </div><!-- doc-content -->
  180. <!-- start footer part -->
  181. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  182. <ul>
  183. <li class="navelem"><a class="el" href="CmdLineBuild.html">Command Line Build</a></li>
  184. <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.
  185. <!--
  186. <a href="http://www.doxygen.org/index.html">
  187. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  188. -->
  189. </li>
  190. </ul>
  191. </div>
  192. </body>
  193. </html>