doc/build/html/commands/compile.html

   1
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   3   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   4
   5 <html xmlns="http://www.w3.org/1999/xhtml">
   6   <head>
   7     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
   8     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   9     <title>Command compile &#8212; salomeTools 5.0.0dev documentation</title>
  10     <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
  11     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  12     <script type="text/javascript" src="../_static/documentation_options.js"></script>
  13     <script type="text/javascript" src="../_static/jquery.js"></script>
  14     <script type="text/javascript" src="../_static/underscore.js"></script>
  15     <script type="text/javascript" src="../_static/doctools.js"></script>
  16     <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
  17     <link rel="index" title="Index" href="../genindex.html" />
  18     <link rel="search" title="Search" href="../search.html" />
  19     <link rel="next" title="Command launcher" href="launcher.html" />
  20     <link rel="prev" title="Command prepare" href="prepare.html" />
  21
  22   <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
  23
  24
  25   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  26
  27   </head><body>
  28
  29
  30     <div class="document">
  31       <div class="documentwrapper">
  32         <div class="bodywrapper">
  33           <div class="body" role="main">
  34
  35   <div class="section" id="command-compile">
  36 <h1>Command compile<a class="headerlink" href="#command-compile" title="Permalink to this headline">¶</a></h1>
  37 <div class="section" id="description">
  38 <h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
  39 <p>The <strong>compile</strong> command allows compiling the products of a <a class="reference external" href="http://www.salome-platform.org">SALOME</a> application.</p>
  40 </div>
  41 <div class="section" id="usage">
  42 <h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
  43 <ul>
  44 <li><p class="first">Compile a complete application:</p>
  45 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o">&lt;</span><span class="n">application</span><span class="o">&gt;</span>
  46 </pre></div>
  47 </div>
  48 </li>
  49 <li><p class="first">Compile only some products:</p>
  50 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o">&lt;</span><span class="n">application</span><span class="o">&gt;</span> <span class="o">--</span><span class="n">products</span> <span class="o">&lt;</span><span class="n">product1</span><span class="o">&gt;</span><span class="p">,</span><span class="o">&lt;</span><span class="n">product2</span><span class="o">&gt;</span> <span class="o">...</span>
  51 </pre></div>
  52 </div>
  53 </li>
  54 <li><p class="first">Use <em>sat -t</em> to duplicate the logs in the terminal (by default the log are stored and displayed with <em>sat log</em> command):</p>
  55 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="o">-</span><span class="n">t</span> <span class="nb">compile</span> <span class="o">&lt;</span><span class="n">application</span><span class="o">&gt;</span> <span class="o">--</span><span class="n">products</span> <span class="o">&lt;</span><span class="n">product1</span><span class="o">&gt;</span>
  56 </pre></div>
  57 </div>
  58 </li>
  59 <li><p class="first">Compile a module and its dependencies:</p>
  60 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o">&lt;</span><span class="n">application</span><span class="o">&gt;</span> <span class="o">--</span><span class="n">products</span> <span class="n">med</span> <span class="o">--</span><span class="n">with_fathers</span>
  61 </pre></div>
  62 </div>
  63 </li>
  64 <li><p class="first">Compile a module and the modules depending on it (for example plugins):</p>
  65 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o">&lt;</span><span class="n">application</span><span class="o">&gt;</span> <span class="o">--</span><span class="n">products</span> <span class="n">med</span> <span class="o">--</span><span class="n">with_children</span>
  66 </pre></div>
  67 </div>
  68 </li>
  69 <li><p class="first">Clean the build and install directories before starting compilation:</p>
  70 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o">&lt;</span><span class="n">application</span><span class="o">&gt;</span> <span class="o">--</span><span class="n">products</span> <span class="n">GEOM</span>  <span class="o">--</span><span class="n">clean_all</span>
  71 </pre></div>
  72 </div>
  73 <div class="admonition note">
  74 <p class="first admonition-title">Note</p>
  75 <div class="last line-block">
  76 <div class="line">a warning will be shown if option <em>–products</em> is missing</div>
  77 <div class="line">(as it will clean everything)</div>
  78 </div>
  79 </div>
  80 </li>
  81 <li><p class="first">Clean only the install directories before starting compilation:</p>
  82 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o">&lt;</span><span class="n">application</span><span class="o">&gt;</span> <span class="o">--</span><span class="n">clean_install</span>
  83 </pre></div>
  84 </div>
  85 </li>
  86 <li><p class="first">Add options for make:</p>
  87 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o">&lt;</span><span class="n">application</span><span class="o">&gt;</span> <span class="o">--</span><span class="n">products</span> <span class="o">&lt;</span><span class="n">product</span><span class="o">&gt;</span> <span class="o">--</span><span class="n">make_flags</span> <span class="o">&lt;</span><span class="n">flags</span><span class="o">&gt;</span>
  88 </pre></div>
  89 </div>
  90 </li>
  91 <li><p class="first">Use the <em>–check</em> option to execute the unit tests after compilation:</p>
  92 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o">&lt;</span><span class="n">application</span><span class="o">&gt;</span> <span class="o">--</span><span class="n">check</span>
  93 </pre></div>
  94 </div>
  95 </li>
  96 <li><p class="first">Remove the build directory after successful compilation (some build directory like qt are big):</p>
  97 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o">&lt;</span><span class="n">application</span><span class="o">&gt;</span> <span class="o">--</span><span class="n">products</span> <span class="n">qt</span> <span class="o">--</span><span class="n">clean_build_after</span>
  98 </pre></div>
  99 </div>
 100 </li>
 101 <li><p class="first">Stop the compilation as soon as the compilation of a module fails:</p>
 102 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o">&lt;</span><span class="n">product</span><span class="o">&gt;</span> <span class="o">--</span><span class="n">stop_first_fail</span>
 103 </pre></div>
 104 </div>
 105 </li>
 106 <li><p class="first">Do not compile, just show if products are installed or not, and where is the installation:</p>
 107 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="nb">compile</span> <span class="o">&lt;</span><span class="n">application</span><span class="o">&gt;</span> <span class="o">--</span><span class="n">show</span>
 108 </pre></div>
 109 </div>
 110 </li>
 111 </ul>
 112 </div>
 113 <div class="section" id="some-useful-configuration-pathes">
 114 <h2>Some useful configuration pathes<a class="headerlink" href="#some-useful-configuration-pathes" title="Permalink to this headline">¶</a></h2>
 115 <p>The way to compile a product is defined in the <em>pyconf file configuration</em>.
 116 The main options are:</p>
 117 <blockquote>
 118 <div><ul class="simple">
 119 <li><strong>build_source</strong> : the method used to build the product (cmake/autotools/script)</li>
 120 <li><strong>compil_script</strong> : the compilation script if build_source is equal to “script”</li>
 121 <li><strong>cmake_options</strong> : additional options for cmake.</li>
 122 <li><strong>nb_proc</strong> : number of jobs to use with make for this product.</li>
 123 </ul>
 124 </div></blockquote>
 125 </div>
 126 </div>
 127
 128
 129           </div>
 130         </div>
 131       </div>
 132       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 133         <div class="sphinxsidebarwrapper">
 134             <p class="logo"><a href="../index.html">
 135               <img class="logo" src="../_static/sat_v5.0.png" alt="Logo"/>
 136             </a></p>
 137   <h3><a href="../index.html">Table Of Contents</a></h3>
 138   <ul>
 139 <li><a class="reference internal" href="#">Command compile</a><ul>
 140 <li><a class="reference internal" href="#description">Description</a></li>
 141 <li><a class="reference internal" href="#usage">Usage</a></li>
 142 <li><a class="reference internal" href="#some-useful-configuration-pathes">Some useful configuration pathes</a></li>
 143 </ul>
 144 </li>
 145 </ul>
 146 <div class="relations">
 147 <h3>Related Topics</h3>
 148 <ul>
 149   <li><a href="../index.html">Documentation overview</a><ul>
 150       <li>Previous: <a href="prepare.html" title="previous chapter">Command prepare</a></li>
 151       <li>Next: <a href="launcher.html" title="next chapter">Command launcher</a></li>
 152   </ul></li>
 153 </ul>
 154 </div>
 155   <div role="note" aria-label="source link">
 156     <h3>This Page</h3>
 157     <ul class="this-page-menu">
 158       <li><a href="../_sources/commands/compile.rst.txt"
 159             rel="nofollow">Show Source</a></li>
 160     </ul>
 161    </div>
 162 <div id="searchbox" style="display: none" role="search">
 163   <h3>Quick search</h3>
 164     <div class="searchformwrapper">
 165     <form class="search" action="../search.html" method="get">
 166       <input type="text" name="q" />
 167       <input type="submit" value="Go" />
 168       <input type="hidden" name="check_keywords" value="yes" />
 169       <input type="hidden" name="area" value="default" />
 170     </form>
 171     </div>
 172 </div>
 173 <script type="text/javascript">$('#searchbox').show(0);</script>
 174         </div>
 175       </div>
 176       <div class="clearer"></div>
 177     </div>
 178     <div class="footer">
 179       &copy;2018, CEA.
 180
 181       |
 182       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.3</a>
 183       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
 184
 185       |
 186       <a href="../_sources/commands/compile.rst.txt"
 187           rel="nofollow">Page source</a>
 188     </div>
 189
 190
 191
 192
 193   </body>
 194 </html>