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
   6 <html xmlns="http://www.w3.org/1999/xhtml">
   7   <head>
   8     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   9
  10     <title>Command compile &mdash; salomeTools 5.0.0dev documentation</title>
  11
  12     <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
  13     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  14     <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
  15
  16     <script type="text/javascript">
  17       var DOCUMENTATION_OPTIONS = {
  18         URL_ROOT:    '../',
  19         VERSION:     '5.0.0dev',
  20         COLLAPSE_INDEX: false,
  21         FILE_SUFFIX: '.html',
  22         HAS_SOURCE:  true
  23       };
  24     </script>
  25     <script type="text/javascript" src="../_static/jquery.js"></script>
  26     <script type="text/javascript" src="../_static/underscore.js"></script>
  27     <script type="text/javascript" src="../_static/doctools.js"></script>
  28     <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
  29     <link rel="top" title="salomeTools 5.0.0dev documentation" href="../index.html" />
  30     <link rel="next" title="Command launcher" href="launcher.html" />
  31     <link rel="prev" title="Command prepare" href="prepare.html" />
  32
  33   <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
  34
  35
  36   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  37
  38   </head>
  39   <body>
  40
  41
  42     <div class="document">
  43       <div class="documentwrapper">
  44         <div class="bodywrapper">
  45           <div class="body" role="main">
  46
  47   <div class="section" id="command-compile">
  48 <h1>Command compile<a class="headerlink" href="#command-compile" title="Permalink to this headline">¶</a></h1>
  49 <div class="section" id="description">
  50 <h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
  51 <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>
  52 </div>
  53 <div class="section" id="usage">
  54 <h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
  55 <ul>
  56 <li><p class="first">Compile a complete application:</p>
  57 <div class="highlight-python"><pre>sat compile &lt;application&gt;</pre>
  58 </div>
  59 </li>
  60 <li><p class="first">Compile only some products:</p>
  61 <div class="highlight-python"><pre>sat compile &lt;application&gt; --products &lt;product1&gt;,&lt;product2&gt; ...</pre>
  62 </div>
  63 </li>
  64 <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>
  65 <div class="highlight-python"><pre>sat -t compile &lt;application&gt; --products &lt;product1&gt;</pre>
  66 </div>
  67 </li>
  68 <li><p class="first">Compile a module and its dependencies:</p>
  69 <div class="highlight-python"><pre>sat compile &lt;application&gt; --products med --with_fathers</pre>
  70 </div>
  71 </li>
  72 <li><p class="first">Compile a module and the modules depending on it (for example plugins):</p>
  73 <div class="highlight-python"><pre>sat compile &lt;application&gt; --products med --with_children</pre>
  74 </div>
  75 </li>
  76 <li><p class="first">Clean the build and install directories before starting compilation:</p>
  77 <div class="highlight-python"><pre>sat compile &lt;application&gt; --products GEOM  --clean_all</pre>
  78 </div>
  79 <div class="admonition note">
  80 <p class="first admonition-title">Note</p>
  81 <div class="last line-block">
  82 <div class="line">a warning will be shown if option <em>--products</em> is missing</div>
  83 <div class="line">(as it will clean everything)</div>
  84 </div>
  85 </div>
  86 </li>
  87 <li><p class="first">Clean only the install directories before starting compilation:</p>
  88 <div class="highlight-python"><pre>sat compile &lt;application&gt; --clean_install</pre>
  89 </div>
  90 </li>
  91 <li><p class="first">Add options for make:</p>
  92 <div class="highlight-python"><pre>sat compile &lt;application&gt; --products &lt;product&gt; --make_flags &lt;flags&gt;</pre>
  93 </div>
  94 </li>
  95 <li><p class="first">Use the <em>--check</em> option to execute the unit tests after compilation:</p>
  96 <div class="highlight-python"><pre>sat compile &lt;application&gt; --check</pre>
  97 </div>
  98 </li>
  99 <li><p class="first">Remove the build directory after successful compilation (some build directory like qt are big):</p>
 100 <div class="highlight-python"><pre>sat compile &lt;application&gt; --products qt --clean_build_after</pre>
 101 </div>
 102 </li>
 103 <li><p class="first">Stop the compilation as soon as the compilation of a module fails:</p>
 104 <div class="highlight-python"><pre>sat compile &lt;product&gt; --stop_first_fail</pre>
 105 </div>
 106 </li>
 107 <li><p class="first">Do not compile, just show if products are installed or not, and where is the installation:</p>
 108 <div class="highlight-python"><pre>sat compile &lt;application&gt; --show</pre>
 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 &quot;script&quot;</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">
 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   <h3>This Page</h3>
 156   <ul class="this-page-menu">
 157     <li><a href="../_sources/commands/compile.txt"
 158            rel="nofollow">Show Source</a></li>
 159   </ul>
 160 <div id="searchbox" style="display: none">
 161   <h3>Quick search</h3>
 162     <form class="search" action="../search.html" method="get">
 163       <input type="text" name="q" />
 164       <input type="submit" value="Go" />
 165       <input type="hidden" name="check_keywords" value="yes" />
 166       <input type="hidden" name="area" value="default" />
 167     </form>
 168     <p class="searchtip" style="font-size: 90%">
 169     Enter search terms or a module, class or function name.
 170     </p>
 171 </div>
 172 <script type="text/javascript">$('#searchbox').show(0);</script>
 173         </div>
 174       </div>
 175       <div class="clearer"></div>
 176     </div>
 177     <div class="footer">
 178       &copy;2018, CEA.
 179
 180       |
 181       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
 182       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
 183
 184       |
 185       <a href="../_sources/commands/compile.txt"
 186           rel="nofollow">Page source</a>
 187     </div>
 188
 189
 190
 191
 192   </body>
 193 </html>